Getting started
Install the myco CLI, then turn a repo's project/ directory into a work ledger — tasks, issues, proposals, plans, ADRs, handoffs — that lives on its own orphan branch.
Install
The crates.io name myco belongs to an unrelated project — install from the repo:
cargo install --git https://github.com/9aia/mycoFrom a checkout of this repo: cargo xtask install builds and installs the release binary to ~/.cargo/bin/myco.
Set up a repo
cd your-repo
myco initinit creates the orphan project branch, mounts it as a project/ worktree, seeds meta.toml, TODO.md, BACKLOG.md, index.md and the item dirs (issues/, proposals/, plans/, adrs/, handoffs/), adds project/ to .gitignore on your code branch, and writes a managed Agent awareness block into AGENTS.md. It is idempotent — run it again and a healthy worktree is verified, a damaged one repaired.
First items
myco todo add "ship the thing" --pri high --label release
myco item set T-001 --status in-progress
myco status # ledger digest
myco todo done T-001 # the line leaves TODO.md — git history keeps itEvery mutating verb is one atomic commit on the project branch — the branch history is the audit trail. --no-commit (or the MYCO_NO_COMMIT env var) opts out.
The interactive board
myco ui opens a full-screen board over TODO.md and BACKLOG.md — the human cockpit while agents drive the verbs. Every mutation runs through the same ops the CLI uses, so a keypress that changes the ledger lands as the same atomic commit (--no-commit opts out here too).
| Key | Action |
|---|---|
1 / 2, h / l | switch TODO / BACKLOG tab |
j / k, gg / G | move, jump to first / last |
Enter | full-pane item preview (esc back) |
a | add an item to the active board |
dd / Space | mark done |
D / p | defer to BACKLOG / promote back to TODO |
Alt+j / Alt+k | reorder among siblings |
E / R | open the board file in $EDITOR / reload |
q | quit |
The TUI is a default cargo feature — for a lean binary without it, install with --no-default-features:
cargo install --git https://github.com/9aia/myco --no-default-featuresAgent self-discovery
myco manifest # capabilities + protocol version (JSON)
myco schema # the file/state spec as JSON Schema
myco status --prompt # token-sized digest for a context windowEvery verb accepts --json. myco check validates the ledger — file schemas, state machine, index drift — and myco check --fix repairs what it safely can.
Where next
- Your first item — a guided walk through a full task lifecycle.
- Set up myco on a repository — discovery, overrides, non-standard layouts.
- The worktree model — what is actually on disk and why.
- CLI reference — the full verb surface.