Product CLI for installing and operating a local Aionis Runtime.
npx aionis setupaionis setup is the recommended first entry point. It installs the Runtime,
collects a required embedding provider key with hidden terminal input when needed,
writes the generated Runtime .env through @aionis/create, and prints the
next commands for starting the Runtime and connecting SDK, HTTP, MCP, AIFS, or
native plugins.
Setup is for real Agent use. It installs the Runtime and integration surfaces without running optional verification flows by default.
The top-level CLI does not duplicate installer logic. It delegates the actual
Runtime install to the published @aionis/create package internally, while
keeping npx aionis setup as the public product entry point.
To make Verified Continuity usable immediately, bind setup to the project's real acceptance command:
npx aionis setup \
--provider none \
--verify-command "npm test" \
--project-dir . \
--yesInteractive setup also offers this as an explicit choice. When selected, the
installer prints the resulting required_verifier_id and a generated
AgentSession starter. The verifier is disabled when no command is selected;
setup never substitutes a fake always-pass check.
API keys are passed to the installer process through environment variables, not through command-line arguments, so they are not echoed into shell history or the printed install plan.
For non-interactive installs, the matching provider key is required. Aionis
fails before cloning if --yes is used with a real provider and no provider key
is available.
Useful non-interactive runs:
OPENAI_API_KEY="sk-..." npx aionis setup .aionis-runtime --provider openai --yes
DASHSCOPE_API_KEY="sk-..." npx aionis setup .aionis-runtime --provider dashscope --yes
MINIMAX_API_KEY="sk-..." npx aionis setup .aionis-runtime --provider minimax --yes
OPENAI_API_KEY="sk-..." npx aionis setup --with-claude-code --provider openai --yes
MINIMAX_API_KEY="sk-..." npx aionis setup --with-zvec-ann --provider minimax --yes
MINIMAX_API_KEY="sk-..." npx aionis setup --profile full-local --provider minimax --yes--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.
Dry-run without installing:
npx aionis setup --provider openai --dry-runaionis health confirms that the installed Runtime is reachable.
npx aionis health --runtime-url http://127.0.0.1:3001Useful options:
--runtime-url <url> Defaults to AIONIS_URL, AIONIS_BASE_URL,
AIONIS_RUNTIME_URL, or http://127.0.0.1:3001
--api-key <key> Defaults to AIONIS_API_KEY
--json Print the raw Runtime responseaionis forget is the explicit user-control surface for suppressing,
unsuppressing, rehydrating, or activating memory. It previews the request by
default and only calls Runtime when --commit is present.
# Preview a controlled forgetting or rehydration action.
npx aionis forget rehydrate --memory-id mem_123 --reason "inspect archived evidence"
# Commit the lifecycle action explicitly.
npx aionis forget rehydrate --memory-id mem_123 --reason "inspect archived evidence" --commitUseful options:
--input <path> JSON request body merged before command flags
--runtime-url <url> Defaults to AIONIS_URL, AIONIS_BASE_URL,
AIONIS_RUNTIME_URL, or http://127.0.0.1:3001
--api-key <key> Defaults to AIONIS_API_KEY
--tenant-id <id>
--scope <scope>
--reason <text>
--memory-id <id> Repeatable for aionis forget
--anchor-id <id>
--anchor-uri <uri>
--commit Required before aionis forget mutates Runtime lifecycle state
--json