54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
# Axolotl
|
|
|
|
CLI-native issue tracker for you and your agents. Single binary, SQLite-backed, a few lines of Go.
|
|
|
|
## Install
|
|
|
|
**Alpine Linux** (apk):
|
|
Download from the Gitea package registry. Have a look
|
|
[here](https://g.eliaskohout.de/eliaskohout/-/packages/alpine/axolotl/).
|
|
|
|
**Arch Linux** (pacman):
|
|
Download from the Gitea package registry. Have a look
|
|
[here](https://g.eliaskohout.de/eliaskohout/-/packages/arch/axolotl/).
|
|
|
|
**From source:**
|
|
```bash
|
|
go build -o ax ./src
|
|
```
|
|
|
|
**Docker (server mode):**
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
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](USAGE.md).
|
|
|
|
## License
|
|
|
|
MIT
|