Install Aionis

Aionis ships as a local-first Runtime plus separate package entry points for SDK, MCP, and Claude Code lifecycle hooks.

One-command Installer

npx @aionis/create@latest

The installer:

1. clones the Runtime repository,
2. installs workspace dependencies,
3. writes a local .env,
4. builds the SDK, MCP, installer, and Claude Code helper packages,
5. runs the no-key first-value demo by default.

Run the full SDK quickstart with OpenAI-compatible embeddings:

OPENAI_API_KEY="your-key" npx @aionis/create@latest --provider openai --quickstart sdk

Install Runtime and add the AIFS file-surface package:

npx @aionis/create@latest my-aionis --with-aifs

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