Install
Requirements
- Python 3.10 or newer.
- SQLite with FTS5.
- A writable repository tree.
Auwai has no runtime dependency beyond the standard library. Optional database and queue clients are extras. The native harness plugins are separate surfaces; see plugins.
From a release wheel
python -m pip install auwai_kernel-1.0.0-py3-none-any.whl
auwai --version
auwai doctor
The distribution is auwai-kernel; the console script is auwai. The wheel
contains the kernel modules, the skill scripts, schema/, and SKILL.md.
Optional extras:
python -m pip install 'auwai-kernel[postgres]'
python -m pip install 'auwai-kernel[mysql]'
python -m pip install 'auwai-kernel[queues]'
The core install does not pull a database driver or a queue client.
Verify the installed package without the source checkout:
auwai --version
auwai doctor
auwai index --repo /path/to/repo
auwai fullread plan --repo /path/to/repo --context-window 262144
From a checkout
git clone https://github.com/SyntaxErr0r42/auwai.git
cd auwai
mkdir -p ~/.config/auwai
cp config.example.toml ~/.config/auwai/config.toml
./auwai index --repo /path/to/repo
./auwai doctor
./auwai survey --repo /path/to/repo
Set [budget] context_window in the config to the model window.
In Hermes, /auwai-init runs the same check interactively and writes the file.
See initialization.
The index and the coverage ledger are written under /path/to/repo/.auwai.
No source file is modified.
Verify SQLite
auwai doctor
The doctor prints the SQLite version and fts5 yes or fts5 no.
It runs an in-memory FTS5 probe, so the answer is about the interpreter that
runs Auwai.
If FTS5 is missing, the ledger search fails. The JSONL index still works, but query, coverage, and full-read do not.
Harness plugins
Generate and install a plugin:
make plugins
python3 scripts/install_plugin.py --harness opencode --scope project
python3 scripts/install_plugin.py --harness hermes --scope user
Claude Code and Codex use their plugin marketplace CLIs; the installer prints
the exact commands with --dry-run. See plugins for the
capability matrix and the Codex hook trust step.
Knowledge service
SQLite is the default. To use PostgreSQL or MySQL/MariaDB, install the extra
and point --database at the URL:
auwai serve --database postgresql://auwai:secret@127.0.0.1/auwai
auwai serve --database mysql://auwai:secret@127.0.0.1/auwai
Check and apply schema migrations before starting a new release:
auwai serve --database "$AUWAI_DATABASE" --check
auwai serve --database "$AUWAI_DATABASE" --migrate
--check reports pending migrations without writing. Startup refuses a schema
newer than the release. See knowledge service and
security.
First full read
auwai fullread plan --repo /path/to/repo
auwai fullread next --repo /path/to/repo
auwai fullread read --repo /path/to/repo
The first plan prints the read budget and segment count. Check that the fixed prompt and output reserve match the target harness.