Prerequisites -- Axon

September 5, 2026 ยท View on GitHub

Required tools and versions before developing or deploying.

Required tools

ToolVersionInstallPurpose
Rust1.97.1rustup.rsCompiler (pinned via rust-toolchain.toml)
Docker24+docs.docker.comInfrastructure services
Docker Composev2+Bundled with DockerService orchestration
justlatestcargo install justTask runner
Node.js24+nodejs.orgWeb UI runtime and npm
jq1.6+System package managerJSON parsing in scripts
curlanySystem package managerHTTP testing
Python3.10+System package managerScripts and analysis tools

Verify

rustc --version          # rustc 1.97.1
cargo --version          # cargo 1.97.1
docker --version         # Docker 24+
docker compose version   # Docker Compose v2+
just --version           # just x.y.z
node --version           # v24.0.0 or newer
npm --version            # npm bundled with Node.js
jq --version             # jq-1.6+
python3 --version        # Python 3.10+

Automated setup

The setup script installs everything:

just setup
# or directly:
./scripts/dev-setup.sh

This installs: Rust toolchain components and cargo tools, then runs npm ci for the web panel and verifies all prerequisites. If just is not yet installed, dev-setup.sh installs it.

ToolInstallPurpose
kachemise installCompilation cache (global rustc-wrapper)
moldSystem package managerFast linker (auto-detected by Justfile)
cargo-nextestcargo install cargo-nextestFaster parallel test runner
cargo-denycargo install cargo-denyDependency auditing
cargo-llvm-covcargo install cargo-llvm-covCode coverage
lefthookcargo install lefthookGit hooks
ghcli.github.comGitHub CLI for PRs and issues

Infrastructure services

Infrastructure runs via Docker Compose. No manual installation needed:

ServiceDocker imageHost portPurpose
Qdrantqdrant/qdrant:v1.18.253333Vector store
TEIghcr.io/huggingface/text-embeddings-inference:89-1.952000Embedding generation
ChromeCustom (config/chrome/)6000Headless browser

Start all infrastructure:

just services-up

GPU requirements (optional)

TEI benefits from GPU acceleration for embedding generation:

  • NVIDIA GPU with CUDA drivers
  • docker compose --env-file ~/.axon/.env -f docker-compose.prod.yaml up -d
  • CPU-only: use an external TEI_URL or override the TEI image/settings to remove the NVIDIA device reservation before starting the default services compose file.

System resources

Recommended minimums for local development:

ResourceMinimumRecommended
RAM8 GB16+ GB
Disk20 GB50+ GB (for Qdrant data and TEI models)
CPU4 cores8+ cores (concurrency scales with cores)

Quick start

git clone https://github.com/dinglebear-ai/axon.git ~/workspace/axon
cd ~/workspace/axon
just setup               # Install all tools
mkdir -m 700 -p ~/.axon
cp .env.example ~/.axon/.env && chmod 600 ~/.axon/.env
# Edit ~/.axon/.env with credentials
just services-up          # Start infrastructure
just dev                  # Build + run full stack

See also