Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quick Start

1. Initialize Configuration

axe config init

Creates $XDG_CONFIG_HOME/axe/ with a sample skill and default config.toml.

2. Scaffold an Agent

axe agents init my-agent

3. Edit the Agent

axe agents edit my-agent

4. Run the Agent

axe run my-agent

Piping Input

Axe accepts stdin, so you can pipe output from other tools directly into an agent:

git diff --cached | axe run pr-reviewer
cat error.log | axe run log-analyzer

Examples

The examples/ directory contains ready-to-run agents you can copy and use immediately — a code reviewer, commit message generator, and text summarizer, each with a focused SKILL.md.

# Copy an example agent into your config
cp examples/code-reviewer/code-reviewer.toml "$(axe config path)/agents/"
cp -r examples/code-reviewer/skills/ "$(axe config path)/skills/"

# Set your API key and run
export ANTHROPIC_API_KEY="your-key-here"
git diff | axe run code-reviewer