rustbrain 0.3.1

CLI for rustbrain — a lightweight Rust-native second brain for humans and AI agents
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# rustbrain (CLI)

Command-line interface for [rustbrain](https://github.com/shan-alexander/rustbrain).

**crates.io:** `rustbrain` · **binary:** `rustbrain` · **library:** use [`rustbrain-core`](https://crates.io/crates/rustbrain-core)

## Install

```bash
cargo install rustbrain --locked
# pin: cargo install rustbrain --version 0.3.1 --locked
```

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

## Typical workflow

```bash
cd your-project
rustbrain setup --yes

rustbrain note new --type concept --title "Topic" --note "Body for agents." --sync
rustbrain query "topic" --no-symbols --scores
rustbrain context "explain topic" -F markdown --hops 1
rustbrain links
```

## Commands

| Command | Description |
|---------|-------------|
| `setup` | One-shot init + bootstrap + sync + doctor |
| `init` | Create `.brain/db.sqlite` |
| `bootstrap` | Scaffold docs, ignore file, README harvest, AST map (`--yes`, `--write`, `--force`) |
| `sync` | Index notes + Rust AST; bake CSR mmap |
| `doctor` | Health + pending links (`--json`, `--strict`) |
| `note new` | Create note (`--type`, `--title`, `--note`, `--sync`) |
| `links` | List pending unresolved links |
| `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](../../docs/CLI.md)** in the repo.

### Agent tip: `note new`

```bash
rustbrain note new \
  --type adr \
  --title "Prefer path deps in workspace" \
  --note "Keeps publish graph simple; only core + CLI on crates.io." \
  --tags "packaging" \
  --sync
```

### 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