@aionis/create

One-command installer for Aionis Runtime, SDK, MCP bridge, AIFS, and optional Claude Code lifecycle hooks.

Docs: https://docs.aionis.work/developer-platform/start/install

Source repositories:

• Runtime: ostinatocc/Aionis
• Installer package: ostinatocc/aionis-create
• SDK package: ostinatocc/aionis-sdk
• MCP package: ostinatocc/aionis-mcp
• AIFS package: ostinatocc/aionis-aifs
• Claude Code plugin: ostinatocc/aionis-claude-code

@aionis/create@0.3.8 installs Runtime v0.3.6 by default and requires Node.js >=22.13.0. Pass --branch <ref> only when you intentionally need a different Runtime branch or tag.

Run:

npx @aionis/create@latest

For the guided product setup flow, use the top-level CLI instead:

npx aionis setup

That command prompts for provider and integration choices, collects optional API keys with hidden terminal input, then delegates the install to this package.

The default run installs Aionis and prepares the Runtime for Agent integration. It does not run optional verification flows by default.

Install with OpenAI-compatible embeddings:

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

Install with DashScope text-embedding-v4:

DASHSCOPE_API_KEY="your-key" npx @aionis/create@latest --provider dashscope

Install Runtime only:

npx @aionis/create@latest my-aionis --skip-quickstart

Install Runtime into a side directory and onboard Claude Code globally:

npx @aionis/create@latest .aionis-runtime --with-claude-code

This writes PORT=3101 into .aionis-runtime/.env, matching the Claude Code plugin default http://127.0.0.1:3101. Start Runtime with:

cd .aionis-runtime
npm run -s lite:start

Install Runtime with the optional local Zvec ANN candidate index:

npx @aionis/create@latest .aionis-runtime --with-zvec-ann

When --with-zvec-ann is set, the installer writes the Runtime ANN env, installs @zvec/zvec@0.5.0 in the Runtime directory, verifies that it can be imported, and leaves SQLite as the Runtime fact source. If the native package is not available for the current platform, rerun without --with-zvec-ann.

Install Runtime with the local full profile:

npx @aionis/create@latest .aionis-runtime --profile full-local

--profile full-local composes existing local integration options. It enables AIFS setup guidance and the Zvec ANN candidate index. It does not install Claude Code hooks or Substrate unless you choose those advanced integrations separately.

Install Runtime and include AIFS file-surface setup commands in the completion output:

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

@aionis/create does not add AIFS to the Runtime package.json. 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

The installer clones the Runtime repo, installs dependencies, writes .env, runs the Runtime build check, then optionally runs Claude Code onboarding. Use @aionis/sdk for application integration, @aionis/mcp for MCP clients, @aionis/aifs for .aionis/ workspace files, and @aionis/claude-code for Claude Code lifecycle integration.

If no embedding key is detected, the installer can write EMBEDDING_PROVIDER=none so the local Runtime can start immediately. That no-key mode is useful for connectivity and governance checks, but stored-memory semantic recall needs a provider key. Configure semantic recall by setting EMBEDDING_PROVIDER=openai plus OPENAI_API_KEY, or EMBEDDING_PROVIDER=dashscope plus DASHSCOPE_API_KEY, or EMBEDDING_PROVIDER=minimax plus MINIMAX_API_KEY, in the generated .env.

Common first runs:

OPENAI_API_KEY="your-key" npx @aionis/create@latest --provider openai
DASHSCOPE_API_KEY="your-key" npx @aionis/create@latest --provider dashscope

After install, pick the integration path:

• SDK: https://docs.aionis.work/plugins/sdk
• AIFS: https://docs.aionis.work/plugins/aifs
• Claude Code hooks: https://docs.aionis.work/plugins/claude-code
• MCP for Claude Code / Cursor: https://docs.aionis.work/plugins/mcp
• Memory Firewall: https://docs.aionis.work/developer-platform/products/memory-firewall