Skip to content

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:

sh
cargo install --git https://github.com/9aia/myco

From a checkout of this repo: cargo xtask install builds and installs the release binary to ~/.cargo/bin/myco.

Set up a repo ​

sh
cd your-repo
myco init

init 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 ​

sh
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 it

Every 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).

KeyAction
1 / 2, h / lswitch TODO / BACKLOG tab
j / k, gg / Gmove, jump to first / last
Enterfull-pane item preview (esc back)
aadd an item to the active board
dd / Spacemark done
D / pdefer to BACKLOG / promote back to TODO
Alt+j / Alt+kreorder among siblings
E / Ropen the board file in $EDITOR / reload
qquit

The TUI is a default cargo feature — for a lean binary without it, install with --no-default-features:

sh
cargo install --git https://github.com/9aia/myco --no-default-features

Agent self-discovery ​

sh
myco manifest          # capabilities + protocol version (JSON)
myco schema            # the file/state spec as JSON Schema
myco status --prompt   # token-sized digest for a context window

Every 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 ​