Commonplace CLI commands

Type: kb/types/note.md · Status: current

All commands are installed by pip install llm-commonplace and available as commonplace-* on PATH. Run any command with --help for full usage.

Project setup

commonplace-init

Initialize or update a Commonplace project. Creates KB directories, seeds instructions and type definitions, installs skills into both .claude/skills/ and .agents/skills/, and resolves templates.

commonplace-init --name <project-name>
commonplace-init --root /path/to/project

--name sets the project name for templates (defaults to directory name). Safe to rerun — never overwrites existing files, and reports whether preserved files already match the scaffold or differ from what the current run would generate.

Validation and indexing

commonplace-validate

Deterministic validator for KB notes. Checks frontmatter validity, enum values, link health, description quality, required sections, and batch signals (orphan detection, seedling counts).

commonplace-validate notes               # validate one collection by name
commonplace-validate kb/notes/           # validate one collection by path
commonplace-validate kb/notes/my-note.md # validate one note

Bare kb and all are rejected — scope must be a specific collection or file. To validate the authored library, loop over the collections explicitly:

for c in notes reference instructions agent-memory-systems sources; do
  commonplace-validate "$c"
done

commonplace-generate-notes-index

Generate an index.md file from frontmatter of all markdown files in a directory. Lists each note with its description.

commonplace-generate-notes-index kb/notes
commonplace-generate-notes-index kb/sources

commonplace-refresh-indexes

Refresh the checked-in generated indexes used locally and by GitHub Pages. Rebuilds the directory indexes for notes and sources, then refreshes generated sections of managed generated-tail indexes.

commonplace-refresh-indexes

commonplace-sync-generated-index

Rebuild auto-generated sections of index pages with generated tails. Uses index_source metadata to decide whether a page lists tagged notes or tag indexes.

commonplace-sync-generated-index                           # all indexes
commonplace-sync-generated-index kb/notes/tags-index.md    # specific index
commonplace-sync-generated-index --dry-run                 # preview changes

Note operations

commonplace-relocate-note

Rename or move a note, updating all backlinks across the KB.

commonplace-relocate-note old-note "New note title" --apply
commonplace-relocate-note old-note --to kb/notes/definitions --apply
commonplace-relocate-note old-note --to kb/notes/new-path.md --apply

Without --apply, previews changes without writing.

commonplace-relocate-directory

Move a KB directory, updating links and optionally adding one MkDocs redirect.

commonplace-relocate-directory kb/notes/related-systems kb/agent-memory-systems --apply
commonplace-relocate-directory kb/notes/related-systems kb/agent-memory-systems --redirect notes/related-systems/related-systems-index.md:agent-memory-systems/index.md --apply

Without --apply, previews changes without writing. --redirect takes OLD:NEW docs paths for a single redirect entry.

commonplace-promotion-candidates

List text files and seedling notes that may be ready for promotion to higher status.

commonplace-promotion-candidates

Writes results to kb/reports/promotion-candidates.md.

Snapshots

commonplace-github-snapshot

Snapshot a GitHub issue or PR into kb/sources/. Uses the gh CLI to fetch issue/PR data.

commonplace-github-snapshot https://github.com/owner/repo/issues/123
commonplace-github-snapshot --out-dir kb/sources/ https://github.com/owner/repo/pull/456

commonplace-x-snapshot

Snapshot an X/Twitter post into kb/sources/. Requires the xdk package (pip install llm-commonplace[snapshot]).

commonplace-x-snapshot https://x.com/user/status/123456789

Review system

The review system runs LLM-based quality reviews against notes using defined review gates. For the full review workflow, read ../instructions/REVIEW-SYSTEM.md. For the code architecture, see review-architecture.md.

commonplace-review-sweep

Run a full review sweep — selects notes needing review and runs gate bundles on them.

commonplace-review-sweep prose kb/notes kb/reference --model claude-opus-4-6 --runner claude-code
commonplace-review-sweep prose --model claude-opus-4-6 --runner claude-code --current   # only current-status notes
commonplace-review-sweep --all-gates kb/notes kb/reference --model claude-opus-4-6 --runner claude-code       # all gate bundles
commonplace-review-sweep prose kb/notes kb/reference --model claude-opus-4-6 --runner claude-code --dry-run   # preview what would run

commonplace-run-review-bundle

Run a review bundle (set of gates) on a single note.

commonplace-run-review-bundle kb/notes/my-note.md prose --runner claude-code --model claude-opus-4-6

commonplace-run-gate-sweep

Run a single gate across multiple notes in batched prompts.

commonplace-run-gate-sweep semantic/grounding-alignment --runner claude-code --model claude-opus-4-6 --note kb/notes kb/reference
commonplace-run-gate-sweep semantic/grounding-alignment --runner claude-code --model claude-opus-4-6 --current --batch-size 5
commonplace-run-gate-sweep semantic/grounding-alignment --runner claude-code --model claude-opus-4-6 --note kb/notes/specific.md
commonplace-run-gate-sweep semantic/grounding-alignment --runner claude-code --model claude-opus-4-6 --note kb/notes kb/reference --dry-run

commonplace-create-review-run

Create a review run record in the review database. With --with-prompt, also emits the canonical bundle prompt and artifact paths for live-agent review.

commonplace-create-review-run kb/notes/my-note.md prose --runner claude-code --model claude-opus-4-6
commonplace-create-review-run kb/notes/my-note.md prose --runner claude-code --model claude-opus-4-6 --json
commonplace-create-review-run kb/notes/my-note.md prose --runner claude-code --model claude-opus-4-6 --with-prompt

commonplace-ingest-bundle-output

Parse a sentinel-delimited review bundle and finalize its existing review run.

commonplace-ingest-bundle-output --review-run-id 42 --input-file kb/reports/bundle-reviews/review-run-42/bundle-output.md

commonplace-write-gate-review

Record a single gate review from a file into an existing review run. This remains available for manual edge cases; the normal live-agent bundle path uses commonplace-ingest-bundle-output.

commonplace-write-gate-review --review-run-id 42 --gate-id prose/source-residue --input-file review-output.md

commonplace-finalize-review-run

Mark a review run as completed. Validates that all expected gate reviews are present, then appends acceptance events.

commonplace-finalize-review-run --review-run-id 42

commonplace-ack-gate-review

Advance acceptance baseline for specific gates without re-running the review.

commonplace-ack-gate-review kb/notes/my-note.md --model claude-opus-4-6 prose/source-residue semantic/grounding-alignment

commonplace-ack-trivial-note-changes

Auto-acknowledge note-changed stale pairs when only non-watched note parts changed. Each gate declares what it watches (body, title, description) — changes outside the watched set are acked automatically.

commonplace-ack-trivial-note-changes prose --model claude-opus-4-6 --note kb/notes kb/reference  # all prose gates
commonplace-ack-trivial-note-changes prose --model claude-opus-4-6 --current              # current-status notes only
commonplace-ack-trivial-note-changes prose --model claude-opus-4-6 --note kb/notes kb/reference --dry-run  # preview what would ack

commonplace-resolve-gates

Expand gate bundle names to individual gate IDs and output their definitions.

commonplace-resolve-gates prose                                    # all gates in prose bundle
commonplace-resolve-gates prose/source-residue semantic/grounding-alignment  # specific gates

commonplace-review-target-selector

List stale (note, gate) pairs that need review. Compares current note/gate SHAs against accepted SHAs.

commonplace-review-target-selector prose --model claude-opus-4-6 --note kb/notes kb/reference
commonplace-review-target-selector prose --model claude-opus-4-6 --current --json          # JSON output
commonplace-review-target-selector prose --model claude-opus-4-6 --note kb/notes kb/reference --reason note-changed     # filter by staleness reason
commonplace-review-target-selector prose --model claude-opus-4-6 --ack kb/notes/foo.md:prose/source-residue   # ack a pair

commonplace-warn-selector

Extract warn-level findings from effective reviews.

commonplace-warn-selector                                          # all notes
commonplace-warn-selector kb/notes/my-note.md                     # specific note
commonplace-warn-selector --json                                   # JSON output

Review maintenance

Operational commands for database repair and migration. All support --dry-run.

commonplace-reparse-gate-review-decisions

Re-parse decision values from stored review markdown. Useful after decision parsing logic changes.

commonplace-reparse-gate-review-decisions --dry-run
commonplace-reparse-gate-review-decisions --review-run-id 42

commonplace-repair-manual-import-review-results

Re-infer decisions for legacy manual-import reviews with stale footers.

commonplace-repair-manual-import-review-results --dry-run

commonplace-prune-superseded-unknown-manual-import-reviews

Delete manual-import reviews with decision=unknown that have been replaced by definitive reviews.

commonplace-prune-superseded-unknown-manual-import-reviews --dry-run