rustbrain 0.3.10

CLI for rustbrain — a lightweight Rust-native second brain for humans and AI agents
rustbrain-0.3.10 is not a library.

rustbrain (CLI)

Command-line interface for rustbrain.

crates.io: rustbrain · binary: rustbrain · library: use rustbrain-core

Install

cargo install rustbrain --locked
# pin: cargo install rustbrain --version 0.3.10 --locked

Requires a C toolchain (bundled SQLite + tree-sitter).

Typical workflow

cd your-project
rustbrain setup --yes          # docs + AGENTS.md + sync + doctor

# Point coding agents at the generated AGENTS.md (edit or template it org-wide)

# Preferred: type + title only → scaffold → edit the created file → sync
rustbrain note new --type concept --title "Topic"
# edit docs/concepts/topic.md, then:
rustbrain sync

rustbrain query "topic" --scores
rustbrain context "explain topic"
rustbrain links

AGENTS.md

Written by setup / bootstrap unless --no-agents-md. Customize with:

  • --agents-template PATH
  • RUSTBRAIN_AGENTS_TEMPLATE
  • committed AGENTS.template.md or .rustbrain/AGENTS.template.md

Commands

Command Description
setup One-shot init + bootstrap + sync + doctor (--no-agents-md, --agents-template)
init Create .brain/db.sqlite
bootstrap Scaffold docs, AGENTS.md, ignore, README harvest, AST map (--no-agents-md, --agents-template)
sync Index notes + Rust AST; bake CSR mmap
doctor Health + orphans (--orphans, --json, --strict)
note new Prefer --type + --title only (scaffold), then edit file
links / link Pending links, or --auto soft links (--auto path.md)
query Ranked search (--no-symbols, --type, --scores, --all-workspaces)
context Agent context (positional/-p, excerpts, --with-symbols, --no-hop-symbols, -F)
watch Debounced live re-index
export / import .brainbundle portable graph

Full flag reference and nuances: docs/CLI.md in the repo.

Agent tip: note new (scaffold, then edit)

Preferred: omit --body / --note so the type scaffold is written; edit the file; then sync.

rustbrain note new --type adr --title "Prefer path deps in workspace" --tags packaging
# edit docs/adr/prefer-path-deps-in-workspace.md (Status / Context / Decision / …)
rustbrain sync

Use --body only when the full text is already finished (skips scaffold).

Bootstrap tip: interactive ignore

On a TTY without --yes, bootstrap asks whether to create .rustbrainignore, import .gitignore, and add recommended extras (data/, *.parquet, .env, …).

Exit codes

  • 0 — success
  • 1 — error, or doctor --strict with pending/unhealthy state

License

MIT OR Apache-2.0