Install Aionis

Aionis ships as a Runtime plus separate package entry points for SDK, MCP, AIFS, Substrate, and native lifecycle hooks.

One-command Installer

npx aionis setup

The guided setup:

1. clones the Runtime repository,
2. installs workspace dependencies,
3. writes a local .env with your embedding provider settings,
4. asks whether to enable AIFS, Zvec ANN, or Claude Code integration,
5. prints the Runtime URL and Agent integration options.

Use an embedding key during setup when you want stored-memory recall and recall-backed guide output immediately:

OPENAI_API_KEY="your-key" npx aionis setup --provider openai --yes

The installer is for real Agent integration. You can connect SDK, HTTP, MCP, AIFS, Claude Code, or Substrate after the Runtime starts.

Install Runtime and add the AIFS file-surface package:

npx aionis setup my-aionis --with-aifs --yes

Then run AIFS from the agent project that should contain .aionis/:

npx @aionis/aifs@latest init --base-url http://127.0.0.1:3001 --scope my-project
npx @aionis/aifs@latest doctor --base-url http://127.0.0.1:3001 --scope my-project
npx @aionis/aifs@latest refresh --base-url http://127.0.0.1:3001 --scope my-project

After refresh, point your agent at .aionis/AGENT_INSTRUCTIONS.md. That file contains the read order for guide.md, current_active_path.md, do_not_use.md, and rehydrate_needed.md.

Manual Repository Install

git clone https://github.com/ostinatocc/Aionis.git
cd Aionis
npm install

Set an embedding provider:

export EMBEDDING_PROVIDER="openai"
export OPENAI_API_KEY="your-openai-key"

MiniMax is also supported:

export EMBEDDING_PROVIDER="minimax"
export MINIMAX_API_KEY="your-minimax-key"

Then continue with Run the Runtime.

Package Entry Points

Requirements