Skip to content

Getting started

Installation

bash
npm install -g agenix     # or npx agenix ...

Requires Node.js ≥ 20 and an installed executor (e.g. Claude Code or Aider).

Creating an agent

bash
agenix init my-agent --agent claude-code --model anthropic/claude-sonnet-5

This creates a ready-to-use project:

my-agent/
  profile.yaml          # executor + model + auth + knowledge
  knowledge/            # persona, rules, facts, skills, episodes
  suites/smoke.yaml     # starter eval suite

For a local model:

bash
agenix init my-agent --agent aider \
  --model ollama_chat/qwen2.5-coder:14b --base-url http://localhost:11434 \
  --auth inherit

Readiness check

bash
agenix doctor -p my-agent/profile.yaml

doctor checks four things: the executor binary in PATH, authentication (subscription logged in / key stored), the knowledge base loads, and the gateway is reachable if baseUrl is set.

First run

bash
agenix compile -p my-agent/profile.yaml        # inspect the native configs
agenix run -p my-agent/profile.yaml -m "create hello.txt containing hi"
agenix eval -p my-agent/profile.yaml -s my-agent/suites/smoke.yaml

Next: profiles, authentication, self-learning.