Reference
CLI reference
The cumaru binary has 18 commands. This page shows what each one
writes and whether it uses the network. Open a command for its exact options, examples, and
failures.
Running cumaru with no command runs cumaru doctor. Every command
accepts --help.
Navigate
| Command | Purpose | Writes | Network |
|---|
| tree | List filesystem candidates under .cumaru/ and their one-line summaries. | None. | None. |
|---|
| map | List Markdown headings with their section start and end lines. | None. | None. |
|---|
| get | Print selected line ranges of .cumaru/ Markdown files. | None. | None. |
|---|
| context | Rank local files against an English query and print path:range rows with scores. | Only the vector cache under .cumaru/.cache/context/ and, on first write, a .gitignore entry for .cumaru/.cache/. | None. |
|---|
Maintain
| Command | Purpose | Writes | Network |
|---|
| tag | Read, write, and audit semantic tag bodies in Markdown files. | set rewrites one host file through a staged rename. | None. |
|---|
| fs | Move, copy, create, or remove one path inside .cumaru/ with guardrails. | Yes, one path per call. | None. |
|---|
| doctor | Validate the installed configuration, tree, tags, references, and agent instructions. | Only a daily drift cache, .cumaru/.cache/config-<date>.yaml, plus its .gitignore entry. | At most one read of the domain config on GitHub main per day, for the drift check. |
|---|
| coverage | Report which Git-tracked source files the durable specification references. | None. | None. |
|---|
Project
| Command | Purpose | Writes | Network |
|---|
| install | Install one domain from main HEAD and one agent adapter into the current project. | Creates .cumaru/ and the adapter artifacts: skills, instructions, and, for Claude and Codex, the hook file. | Reads the domain from GitHub main, pinned to one commit. |
|---|
| uninstall | Remove the project installation and every Cumaru-owned adapter artifact. | Destructive. | None. |
|---|
| update | Preview or apply a same-version refresh of the project and its agent artifacts from main HEAD. | Preview writes nothing. | Reads the matching domain from GitHub main, except --clear. |
|---|
| bootstrap | Print the post-install bootstrap steps for the installed domain. | None. | Reads domains/__base/bootstrap.md and the optional domain bootstrap.md from main HEAD, pinned to one commit. |
|---|
| migrate | Print the read-only migration instructions for this project. | None. | Reads domains/__base/migration.md and the optional domain extension from main HEAD. |
|---|
| version | Print the CLI identity and, in a project, the installed and latest config version. | None. | Inside a project, reads the domain config at main HEAD to report the latest config and drift. |
|---|
| help | Show CLI help, help for one command, or the domains available at main HEAD. | None. | Command help is offline. |
|---|
Binary and models
| Command | Purpose | Writes | Network |
|---|
| upgrade | Replace the global cumaru binary with the latest release, or check freshness. | Bare upgrade replaces /usr/local/bin/cumaru (sudo only when needed) and records ~/.config/cumaru.json. | Reads release tags with git ls-remote and downloads the release asset. |
|---|
| model | List, download and enable, or release the optional local context encoder. | pull publishes a package under ~/.cumaru/<name>/. | list and pull read GitHub main; pull downloads about 35 MB for bge-micro-v2. |
|---|
Agent hooks
| Command | Purpose | Writes | Network |
|---|
| hooks | Print deterministic offline context payloads for native agent hooks. | None. | None. |
|---|
Audited against cumaru --help of CLI 0.15.3 and the upstream command docs at revision 37ad79f.