Skip to content

Set up myco on a repository ​

myco init turns any git repo into a myco project: an orphan project branch checked out as a project/ worktree.

sh
cd your-repo
myco init

What it creates ​

pathwhat
project/git worktree on the orphan project branch
project/meta.tomlrepo name + per-kind id counters ([next])
project/TODO.mdactive tasks
project/BACKLOG.mddeferred items
project/index.mdhuman-readable ledger index
project/issues/, proposals/, plans/, adrs/, handoffs/file-backed item dirs
.gitignore += project/keeps the worktree out of code commits
AGENTS.mdgains a marker-delimited, myco-managed Agent awareness block

init commits the scaffold on the project branch — your code branch only gains the .gitignore line and the AGENTS.md block. The block teaches agents the myco workflow; it's delimited by <!-- myco:agent-awareness --> markers so prose elsewhere in the file is preserved — a hand-written Agent awareness section is upgraded in place. check validates it as an agents-md finding and check --fix repairs it.

Re-running init ​

init is idempotent: a valid existing worktree gets its scaffold verified/repaired instead of re-created. It is the safe "is this repo set up?" probe. myco org init re-runs it on every registered repo — the rollout path when scaffolding (like the AGENTS.md block) is introduced or updated.

Overrides and discovery ​

--root picks the repo, --dir picks a non-default worktree path (init uses it instead of <root>/project):

sh
myco init --root ~/GitHub/9aia/sepia
myco init --dir ~/work/ledger          # worktree somewhere else

Every other verb discovers the project the same way, in order:

  1. --dir — explicit worktree path
  2. --root — repo root (worktree is <root>/project)
  3. project_dir in myco.toml (see config)
  4. walk up from cwd for a project/ worktree on branch project
  5. cwd inside the worktree itself

A non-standard worktree location stays discoverable if you set project_dir (relative to the repo root) in a myco.toml — the search order is $MYCO_CONFIG → ./myco.toml (where you run myco) → ~/.config/myco/myco.toml.

If the repo has a pm/ dir ​

Don't init — run myco migrate instead. It converts the legacy pm/ layout into a fresh project/ worktree in one pass.