Files

Elias Kohout b6c8a158af docs: simplify README and extract full reference to USAGE.md

- Condensed README to quick overview (~40 lines) with key features
- Added install instructions for Alpine, Arch, source, and Docker
- Created USAGE.md with full command reference, server mode, OIDC, and permission model docs
- New features documented: server mode, OIDC authentication, per-node permissions, multiplatform auto-builds

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

2026-04-02 13:38:38 +02:00

1.8 KiB

Raw Blame History

Axolotl

CLI-native issue tracker for you and your agents. Single binary, SQLite-backed, ~1300 lines of Go.

Install

Alpine Linux (apk): Download from the Gitea package registry. Have a look here.

Arch Linux (pacman): Download from the Gitea package registry. Have a look here.

From source:

go build -o ax ./src

Docker (server mode):

docker run -v ./data:/data g.eliaskohout.de/eliaskohout/axolotl-server:latest

Packages are built automatically on every version tag for linux/amd64 and linux/arm64.

Quick Start

ax init .                                      # create .ax.db in current dir
ax add "Fix login bug" --prio high             # create an issue
ax list --status open                          # list open issues
ax show abc12                                  # show issue details
ax update abc12 --status done                  # close issue
ax inbox                                       # your @mention inbox

Key Features

Graph relations — blocks, subtask, related, assignee
Namespaces — organize issues by project or team
Permissions — per-node access control (can_read, can_write, has_ownership)
Aliases — custom shortcuts with $me, $1, $@ expansion
JSON output — --json flag on all commands for agent integration
Multiuser — @mention auto-creates inbox entries; AX_USER to switch users
Server mode — HTTP JSON API with optional OIDC authentication (ax serve / ax login)
Portable — single .ax.db file, no server required

For full command reference and examples, see USAGE.md.

License

MIT