Skip to content

Commit c4072be

Browse files
docs: align CLI docs with v0.6.14
1 parent 839858d commit c4072be

8 files changed

Lines changed: 19 additions & 33 deletions

File tree

cli/commands/analyze.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ supermodel analyze [path] [flags]
1717

1818
| Flag | Description |
1919
|---|---|
20-
| `--three-file` | Generate `.calls`/`.deps`/`.impact` files instead of a single `.graph` |
2120
| `--no-shards` | Skip writing `.graph.*` shard files |
2221
| `--force` | Re-analyze even if a cached result exists |
2322
| `-o, --output` | Output format: `human` \| `json` |
@@ -29,9 +28,6 @@ supermodel analyze [path] [flags]
2928
# Analyze the current directory
3029
supermodel analyze
3130

32-
# Generate three-file shards (recommended)
33-
supermodel analyze --three-file
34-
3531
# Re-analyze without using the cache, output JSON
3632
supermodel analyze --force -o json
3733

cli/commands/docs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 'docs'
33
description: 'Generate static architecture documentation for a repository'
44
---
55

6-
Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `LLMS.txt`) alongside the HTML.
6+
Generates a static HTML site documenting the architecture of a codebase. The command uploads the repository to the Supermodel API, converts the returned code graph to markdown, and builds a browsable static site with search, dependency graphs, taxonomy navigation, and SEO metadata. The site also emits machine-readable artifacts (JSON-LD and `llms.txt`) alongside the HTML.
77

88
The output directory can be served locally or deployed to any static host (GitHub Pages, Vercel, Netlify, Cloudflare Pages).
99

cli/commands/hook.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: 'hook'
3-
description: 'Forward Claude Code file-change events to the watch daemon'
3+
description: 'Forward Claude Code file-change events to the Supermodel daemon'
44
---
55

6-
Reads a Claude Code `PostToolUse` JSON payload from stdin and forwards the file path to the running watch daemon via UDP. Install as a `PostToolUse` hook in `.claude/settings.json`.
6+
Reads a Claude Code `PostToolUse` JSON payload from stdin and forwards the file path to the running Supermodel daemon via UDP. Install as a `PostToolUse` hook in `.claude/settings.json`.
77

88
## Synopsis
99

@@ -15,7 +15,7 @@ supermodel hook [flags]
1515

1616
| Flag | Description |
1717
|---|---|
18-
| `--port` | UDP port of the watch daemon (default `7734`) |
18+
| `--port` | UDP port of the Supermodel daemon (default `7734`) |
1919
| `-h, --help` | Help for hook |
2020

2121
## Example
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'supermodel'
3-
description: 'Run the watch daemon (the bare command)'
3+
description: 'Run the live graph daemon (the bare command)'
44
---
55

66
Runs a full analysis on startup (using the cached graph if available), then enters daemon mode. Listens for file-change notifications from the `supermodel hook` command and incrementally re-renders affected `.graph.*` sidecar files. Press Ctrl+C to stop and remove graph files.
@@ -13,7 +13,7 @@ supermodel [flags]
1313

1414
## Description
1515

16-
The bare `supermodel` command is the watch daemon. It does not take a subcommand — running it with no arguments starts the long-running process.
16+
The bare `supermodel` command is the live graph daemon. It does not take a subcommand — running it with no arguments starts the long-running process.
1717

1818
By default the daemon listens on UDP (port `7734`) for change notifications pushed by `supermodel hook`. For environments without a hook integration, pass `--fs-watch` to also poll git state (`HEAD`, index mtime, dirty files) every `--poll-interval`.
1919

@@ -36,7 +36,7 @@ By default the daemon listens on UDP (port `7734`) for change notifications push
3636
# Start the daemon in the current directory
3737
supermodel
3838

39-
# Watch a specific project, poll git state as a fallback
39+
# Run on a specific project, poll git state as a fallback
4040
supermodel --dir ./my-project --fs-watch
4141

4242
# Use a custom UDP port if 7734 is taken

cli/install.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@ icon: 'download'
66

77
A single Go binary, no runtime dependencies.
88

9-
## Homebrew
10-
11-
```bash
12-
brew install supermodeltools/tap/supermodel
13-
```
14-
159
## curl
1610

1711
```bash
@@ -44,5 +38,5 @@ supermodel update --check # check without installing
4438
```bash
4539
supermodel logout
4640
rm -rf ~/.supermodel
47-
brew uninstall supermodel # or remove the binary from your PATH
41+
rm "$(command -v supermodel)" # or remove the binary from your PATH manually
4842
```

cli/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Settings live at `~/.supermodel/config.yaml`. Environment variables override fil
4646
api_key: smsk_live_... # or SUPERMODEL_API_KEY
4747
api_base: https://api.supermodeltools.com # or SUPERMODEL_API_BASE
4848
output: human # human | json
49-
files: true # set false (or SUPERMODEL_FILES=false) to skip writing sidecars
49+
shards: true # set false (or SUPERMODEL_SHARDS=false) to skip writing graph files
5050
```
5151
5252
## Next

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
{
5656
"group": "Commands",
5757
"pages": [
58-
"cli/commands/watch",
58+
"cli/commands/supermodel",
5959
"cli/commands/analyze",
6060
"cli/commands/audit",
6161
"cli/commands/blast-radius",

index.mdx

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ title: Introduction
1313

1414
## CLI quickstart
1515

16-
The fastest path: install the binary and run `setup`. The wizard authenticates you, detects your repo, offers to install the Claude Code hook, and starts the watch daemon — one command, end to end.
16+
The fastest path: install the binary and run `setup`. The wizard authenticates you, detects your repo, offers to install the Claude Code hook, and starts the live graph daemon — one command, end to end.
1717

1818
### 1. Install
1919

2020
```bash
2121
curl -fsSL https://supermodeltools.com/install.sh | sh
2222
```
2323

24-
Other options: `brew install supermodeltools/tap/supermodel`, `npm install -g @supermodeltools/cli`, or build from source. See [Installation](/cli/install).
24+
Other options: `npm install -g @supermodeltools/cli` or build from source. See [Installation](/cli/install).
2525

2626
### 2. Run the setup wizard
2727

@@ -37,7 +37,7 @@ The wizard walks four steps:
3737
3. **Agent hook** — if Claude Code is installed, offers to add a `PostToolUse` hook so `.graph.*` files refresh on every `Write`/`Edit`. Cursor, Copilot, Windsurf, and Aider read the files directly — no hook needed.
3838
4. **Shard mode** — enables writing `.graph.*` sidecars next to your source files.
3939

40-
It then runs the watch daemon for you. Press `Ctrl+C` to stop.
40+
It then runs the live graph daemon for you. Press `Ctrl+C` to stop.
4141

4242
### 3. Tell your agent the sidecars exist
4343

@@ -52,31 +52,27 @@ The prompt explains the naming convention (`Foo.py` → `Foo.graph.py`), the thr
5252

5353
### 4. What you get
5454

55-
After setup runs with `--three-file` (recommended), each source file gets three sidecars:
55+
After setup runs, each source file gets one `.graph.*` sidecar with dependency, call, and impact sections:
5656

5757
```
5858
src/
5959
├── login.go
60-
├── login.calls.go ← who calls what, with file:line
61-
├── login.deps.go ← imports and imported-by
62-
└── login.impact.go ← risk level, domains, blast radius
60+
└── login.graph.go ← deps, calls, impact, domains, and blast radius
6361
```
6462

65-
Real output from running the CLI on its own source (`cmd/login.*.go`):
63+
Example output shape from a generated graph file:
6664

6765
```go
68-
// cmd/login.deps.go
66+
// cmd/login.graph.go
6967
// [deps]
7068
// imports internal/auth/doc.go
7169
// imports internal/auth/handler.go
7270
// imported-by main.go
7371

74-
// cmd/login.calls.go
7572
// [calls]
7673
// init → LoginWithToken internal/auth/handler.go:109
7774
// init → Login internal/auth/handler.go:29
7875

79-
// cmd/login.impact.go
8076
// [impact]
8177
// risk MEDIUM
8278
// domains CoreConfig · SupermodelAPI
@@ -89,7 +85,7 @@ Your agent reads these via `cat` and `grep` like any other file. No prompt chang
8985

9086
### 5. Keep it running
9187

92-
The bare `supermodel` command is the watch daemon. Run it any time you want sidecars to stay fresh as you code:
88+
The bare `supermodel` command is the live graph daemon. Run it any time you want graph files to stay fresh as you code:
9389

9490
```bash
9591
supermodel
@@ -98,7 +94,7 @@ supermodel
9894
For one-shot analysis (no daemon), use:
9995

10096
```bash
101-
supermodel analyze --three-file
97+
supermodel analyze
10298
```
10399

104100
### 6. What to do with the graph

0 commit comments

Comments
 (0)