Install

Aquin ships as the aq CLI (TypeScript) plus a Python kernel. Needs Node ≥ 18, npm, and python3. After install run aq help, then aq doctor.

PrerequisiteNode ≥ 18 · npm · python3 · curl/tar for the release install

Install the team release. Downloads aq-latestv.tar.gz into ~/.local/share/aquin-framework, runs npm install && npm link, and sets up the kernel venv.

Flag	Description
AQUIN_INSTALL_DIR	Override install location (default ~/.local/share/aquin-framework).
AQUIN_RELEASE_URL	Override the release tarball URL.
AQUIN_NO_RELEASE	Skip the release download and use a local/source tree.

example

$curl -fsSL https://aq.aquin.app/framework/install.sh | bash

Install from an aqfw checkout.

example

$cd aq && npm install && npm link

Create the kernel virtualenv in a checkout install.

example

$python3 -m venv aq/kernel/.venv

example

$aq/kernel/.venv/bin/pip install -r aq/kernel/requirements.txt

Short Unix-style help for the aq CLI.

example

$aq help

Health check: node, python, kernel, provider, train folder, skills, MCP. Exits 1 if any check fails.

Flag	Description
[dir]	Optional train directory to validate.

example

$aq doctor

Sign in via the auth portal (or paste a token). Account tokens live in ~/.aquin/config.json. Provider API keys are separate under ~/.aq/config.json.

Flag	Description
--token aq-…	Install an existing CLI token.
--check	Print who is signed in.

example

$aq login

example

$aq login --token aq-…

example

$aq login --check

example

$aq logout

example

$aq switch

Configure LLM providers for the agent (openai, anthropic, grok, ollama). Keys in ~/.aq/config.json.

Flag	Description
aq provider <name>	Save key and select provider.
aq provider use <name>	Switch active provider.

example

$aq provider

example

$aq provider openai

example

$aq provider use anthropic