facet adr
Inspect architecture decision proposals without writing files
Aufruf
facet adr [command]
Unterbefehle
Aus facet adr --help (englische Originalhilfe)
Dasselbe Programm führt Registry-Operationen in CI, im Terminal und in Agentensitzungen aus. Die Befehlsbeschreibungen und Optionen unten werden aus der englischen Originalhilfe des Programms generiert.
Starten Sie /facet:setup in Ihrer eingerichteten FACET-Agentensitzung. Die Einrichtung ermittelt das Programm der Distribution und verknüpft es für die Shell. Derselbe facet-Befehl steht anschließend Terminal, Editor und Git-Hooks zur Verfügung.
Mit dem Claude-Plugin steht facet in -Sitzungen bereit. /facet:setup verknüpft es mit einem Verzeichnis im PATH Ihrer Shell, damit auch Terminal, Editor und Git-Hook es finden:
Dein Schritt
facet setup link --candidatesSie sehen
Beschreibbare Verzeichnisse in Ihrem Benutzerverzeichnis, die bereits im PATH Ihrer Login-Shell stehen. Übergeben Sie eines an facet setup link --dir. Der Link verwendet einen versionsunabhängigen Zeiger und bleibt bei Updates gültig. Shell-Startdateien werden nicht geändert.
Jeder Befehl akzeptiert --root <path> für den Repository-Stammordner. Ohne Angabe wird das oberste Git-Verzeichnis verwendet, sonst das aktuelle Verzeichnis.
Inspect architecture decision proposals without writing files
Aufruf
facet adr [command]
Unterbefehle
Aus facet adr --help (englische Originalhilfe)
Print a read-only status diff for an existing docs/adr Markdown file
Aufruf
facet adr propose-status <path> [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the read-only proposal and diff as JSON |
--reason string | reason for this proposal (required for a changed status) |
--status string | one of the four existing ADR statuses |
--superseded-by string | existing different docs/adr file for an abgelöst proposal; metadata only |
Aus facet adr propose-status --help (englische Originalhilfe)
List the declared behaviour that is deliberately not backed by data yet
Aufruf
facet backing [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the list as JSON |
--registry string | only this registry (default: all declared in .facetrc.yaml) |
Aus facet backing --help (englische Originalhilfe)
Report the shape of the registry: how finely the product has been documented
Aufruf
facet calibrate [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the calibration as JSON |
--registry string | measure only this registry (default: all declared in .facetrc.yaml) |
Aus facet calibrate --help (englische Originalhilfe)
Show which project conventions document applies to each registry
Aufruf
facet conventions [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the resolution as JSON |
Aus facet conventions --help (englische Originalhilfe)
Rank features and files by how often they have been fixed
Aufruf
facet defects [flags] facet defects [command]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--by-file | rank files instead of features |
--json | emit the ranking as JSON |
--registry string | only this registry (default: all declared in .facetrc.yaml) |
--top int | show only the first N entries (default: all) |
Unterbefehle
Aus facet defects --help (englische Originalhilfe)
Fill the defect ledger from git history
Aufruf
facet defects backfill [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--dry-run | report what would be written without writing it |
--json | emit the report as JSON |
--limit int | walk at most this many commits back from the starting revision |
--match string | regular expression a commit subject must match (default: (?i)^(fix|bugfix|hotfix)(\([^)]*\))?!?:) |
--registry string | only this registry (default: all declared in .facetrc.yaml) |
--rev string | revision to walk back from (default: HEAD) |
--since string | only commits authored after this date (git syntax, e.g. '90.days' or '2026-01-01') |
--until string | only commits authored before this date |
Aus facet defects backfill --help (englische Originalhilfe)
List the documented behaviour that is a defect rather than a promise
Aufruf
facet deviations [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the list as JSON |
--registry string | only this registry (default: all declared in .facetrc.yaml) |
Aus facet deviations --help (englische Originalhilfe)
Track whether generated documentation still matches its inputs
Aufruf
facet docs [command]
Unterbefehle
Aus facet docs --help (englische Originalhilfe)
Report generated artifacts whose inputs have changed
Aufruf
facet docs check [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit statuses as JSON |
--strict | exit non-zero when any artifact is not current |
Aus facet docs check --help (englische Originalhilfe)
Record what produced a generated artifact
Aufruf
facet docs record [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--artifact string | path to the generated file, relative to the repo root |
--feature string | feature id the artifact was generated from |
--generated-at string | ISO date of generation |
--model string | model that generated the artifact |
--pipeline string | generator pipeline name (default facet-knowledge) |
--prompt-version string | version of the generation prompt |
--slots strings | Knowledge slots the artifact consumed |
Aus facet docs record --help (englische Originalhilfe)
Report anchored source that changed without its record following
Aufruf
facet drift [flags] facet drift [command]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--baseline string | compare against this revision (default: the accepted baseline, else HEAD) |
--json | emit drift as JSON |
--registry string | check only this registry (default: all declared in .facetrc.yaml) |
--repository string | compare only this declared source repository (workspace-relative) |
Unterbefehle
Aus facet drift --help (englische Originalhilfe)
Record that the changes since the baseline have been reviewed
Aufruf
facet drift accept [path...] [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--baseline string | start this acceptance at the confirmed reviewed revision, keeping other incoming paths unreviewed |
--outcome string | what the review concluded (default behavior-unchanged) |
--repository string | accept only this declared source repository; paths stay workspace-relative |
Aus facet drift accept --help (englische Originalhilfe)
Forget this worktree's accepted baseline and compare against HEAD again
Aufruf
facet drift reset [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--repository string | reset only this declared source repository |
Aus facet drift reset --help (englische Originalhilfe)
List identifiers found in scenario text, grouped and gap-checked by band
Aufruf
facet errors [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the register as JSON |
--registry string | only this registry (default: all declared in .facetrc.yaml) |
Aus facet errors --help (englische Originalhilfe)
Keep @facet: anchors in the working copy and out of every commit
Aufruf
facet filter [command]
Unterbefehle
Aus facet filter --help (englische Originalhilfe)
Configure this clone so anchors you add stay out of every commit
Aufruf
facet filter install [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--command string | the facet executable git should run (default: this binary's path) |
Aus facet filter install --help (englische Originalhilfe)
Make 'git status' agree with 'git diff' after editing a private anchor
Aufruf
facet filter refresh [path...]
Keine eigenen Optionen neben --root.
Aus facet filter refresh --help (englische Originalhilfe)
List the private anchors this clone keeps, and any that lost their place
Aufruf
facet filter status
Keine eigenen Optionen neben --root.
Aus facet filter status --help (englische Originalhilfe)
Remove the filter from this clone; private anchors stay in the working copy and become committable
Aufruf
facet filter uninstall
Keine eigenen Optionen neben --root.
Aus facet filter uninstall --help (englische Originalhilfe)
Print the record index agents are given
Aufruf
facet index [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--bare | ids only, without the intent summaries |
--max-bytes int | budget for the rendered index (default 24576) |
Aus facet index --help (englische Originalhilfe)
Check records against their schema and against the code they anchor
Aufruf
facet lint [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit findings as JSON |
--registry string | check only this registry (default: all declared in .facetrc.yaml) |
--skip strings | checks to skip (schema, orphan-ids, orphan-records, variants, taxonomy, glossary, duplicate-glossary-term, glossary-near-miss, duplicate-glossary-category, undeclared-glossary-category, empty-glossary-category, sizing, registry-refs, flags, knowledge, backing, deviation, examples, broken-links, dependencies, superseded-by, proves, verification-targets, unclaimed-tests, sibling-suffix, created-at-history, no-scenarios, anchor-proves, anchor-roles, test-only-anchors, enum-divergence, unanchored-hotspots, undocumented-directories, error-codes, lost-anchors, plugin-lint) |
--staged | check only the index: report the errors it introduces compared with HEAD (what the commit gate runs) |
--today string | ISO date used for flag retirement checks (default: today, UTC) |
Aus facet lint --help (englische Originalhilfe)
Serve FACET code intelligence over LSP on stdio
Aufruf
facet lsp
Keine eigenen Optionen neben --root.
Aus facet lsp --help (englische Originalhilfe)
Serve the registry over MCP on stdio
Aufruf
facet mcp
Keine eigenen Optionen neben --root.
Aus facet mcp --help (englische Originalhilfe)
Install, list, remove and pack Atlas plugins (ADR-0004)
Aufruf
facet plugin [command]
Unterbefehle
Aus facet plugin --help (englische Originalhilfe)
Install a plugin package from a file, folder, https URL, or github:owner/repo@tag
Aufruf
facet plugin add <source> [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--dev | link a working folder instead of copying it (ADR-0004 §8) |
--grant stringArray | grant a right without asking: tools=a,b / env=X,Y / ai=a,b / ai-env=X,Y |
--replace | replace an already-installed plugin of the same id |
--sha256 string | expected SHA256 of the package (required for an https:// source) |
Aus facet plugin add --help (englische Originalhilfe)
List installed plugins
Aufruf
facet plugin list [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | print as JSON |
Aus facet plugin list --help (englische Originalhilfe)
Pack a plugin folder into a .facetplugin, writing SHA256SUMS from the actual files
Aufruf
facet plugin pack <dir> [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
-o, --out string | output path (default <id>-<version>.facetplugin) |
Aus facet plugin pack --help (englische Originalhilfe)
Remove an installed plugin
Aufruf
facet plugin remove <id>
Keine eigenen Optionen neben --root.
Aus facet plugin remove --help (englische Originalhilfe)
Re-install a plugin from the source it was installed from
Aufruf
facet plugin update <id> [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--grant stringArray | grant a right without asking: tools=a,b / env=X,Y / ai=a,b / ai-env=X,Y |
Aus facet plugin update --help (englische Originalhilfe)
Index the registry for retrieval, and search it
Aufruf
facet rag [command]
Unterbefehle
Aus facet rag --help (englische Originalhilfe)
Embed the records and generated documents into a vector index
Aufruf
facet rag index [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--embed-batch int | chunks per request (default 64) |
--embed-dimensions int | shorten vectors, where the provider supports it |
--embed-key-env string | environment variable holding the API key (never the key itself) |
--embed-model string | embedding model name |
--embed-provider string | "openai" for any OpenAI-compatible endpoint, or "local" (default: from .facetrc.yaml) |
--embed-url string | embeddings API root, without /embeddings |
--index-path string | where the index lives (default: docs/facets/generated.rag.bin) |
--json | report the build as JSON |
Aus facet rag index --help (englische Originalhilfe)
Search the index and print the nearest chunks
Aufruf
facet rag query <question> [flags]
--embed-batch int | chunks per request (default 64) |
|---|---|
--embed-dimensions int | shorten vectors, where the provider supports it |
--embed-key-env string | environment variable holding the API key (never the key itself) |
--embed-model string | embedding model name |
--embed-provider string | "openai" for any OpenAI-compatible endpoint, or "local" (default: from .facetrc.yaml) |
--embed-url string | embeddings API root, without /embeddings |
--index-path string | where the index lives (default: docs/facets/generated.rag.bin) |
--json | emit hits as JSON |
--kind string | only "record" chunks or only "doc" chunks |
-n, --limit int | how many chunks to return (default 5) |
--min-score float | drop hits below this cosine similarity |
Aus facet rag query --help (englische Originalhilfe)
Show which features each registry documents
Aufruf
facet registries [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--gaps | show only ids that some registry is missing |
--json | emit the matrix as JSON |
Aus facet registries --help (englische Originalhilfe)
Measure and wire up a project's FACET setup
Aufruf
facet setup [command]
Unterbefehle
Aus facet setup --help (englische Originalhilfe)
Make facet reachable from your shell with a link to the current binary
Aufruf
facet setup link [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--candidates | list user-writable directories on your login shell's PATH |
--dir string | directory to put the facet link in |
--force | link even when the directory is not on your login shell's PATH |
Aus facet setup link --help (englische Originalhilfe)
Install a git pre-commit hook that runs 'facet lint --staged'
Aufruf
facet setup precommit [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--remove | remove the hook, only if FACET wrote it |
--write | install the hook (default: dry run) |
Aus facet setup precommit --help (englische Originalhilfe)
Report, check by check, how far this project's FACET setup goes
Aufruf
facet setup status [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--evidence | print each row's evidence under it |
--json | emit the rows as a JSON array of {id, state, finding, evidence} |
--strict | exit 1 when any row is red |
Aus facet setup status --help (englische Originalhilfe)
Freeze this repository's Atlas corpus into one JSON file
Aufruf
facet snapshot [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--no-excerpts | drop the source line quoted under every anchor |
-o, --out string | file to write ('-' or empty for stdout) |
--registry string | registry to freeze, in a repository that declares several |
Aus facet snapshot --help (englische Originalhilfe)
Report what a re-cut dropped: facets the parent carried and no child does
Aufruf
facet split --check <parent-id> <child-id> [<child-id> ...] [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--check | report what the split dropped |
--from string | git revision, or a path, to read the parent record from (default HEAD) |
--json | machine-readable output |
--registry string | which registry, in a monorepo that declares several |
Aus facet split --help (englische Originalhilfe)
Run declared test commands and report per-file verification results
Aufruf
facet test [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--check | check discovery and baseline drift without executing tests |
--fail-unmeasured | exit 1 on incomplete feature or file evidence; preserve nonzero runner exits |
--json | emit reports as JSON; during execution runner output goes to stderr |
--list | list discovered files and check drift without executing tests |
--only string | show only facet or runner output (execution only) |
--registry string | select one declared registry |
--runner string | select one declared runner; absence across other runners is unmeasured |
--update-baseline | remove stale baseline entries; never add paths |
Aus facet test --help (englische Originalhilfe)
Read this repository's FACET registry in a browser
Aufruf
facet ui [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--companion-bin string | Claude Code executable for the companion (default: claude on PATH) |
--companion-model string | model the companion answers with (default: whatever Claude Code is set to) |
--no-open | do not open a browser, only print the address |
--port int | port to listen on; a taken port falls back to one the system picks (default 7317) |
--record string | open straight at this record id, e.g. tasks/create/quick-add |
--registry string | registry to read (default: the first declared in .facetrc.yaml) |
Aus facet ui --help (englische Originalhilfe)
Read, write and check the project's wiki
Aufruf
facet wiki [command]
Unterbefehle
Aus facet wiki --help (englische Originalhilfe)
Check the wiki, as CI would
Aufruf
facet wiki check [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit findings as JSON |
--registry string | which registry's wiki (default: the first declared) |
--strict | treat every warning as an error |
Aus facet wiki check --help (englische Originalhilfe)
Bring pages in from another system, on a branch, and report what was lost
Aufruf
facet wiki import <source> <ref> [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--branch string | the branch to import onto (default: one named after the reference) |
--json | emit the report as JSON |
--no-commit | write the files on the branch but do not commit them |
--registry string | which registry's wiki (default: the first declared) |
Aus facet wiki import --help (englische Originalhilfe)
List the wiki's pages
Aufruf
facet wiki list [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--bereich string | only pages in this area |
--json | emit the listing as JSON |
--kategorie string | only pages of this category |
--registry string | which registry's wiki (default: the first declared) |
--tag string | only pages carrying this tag |
Aus facet wiki list --help (englische Originalhilfe)
Push the wiki's pages out again, refusing what changed on the far side
Aufruf
facet wiki mirror --to=confluence --space=KEY [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--json | emit the report as JSON |
--registry string | which registry's wiki (default: the first declared) |
--space string | the Confluence space key to push into (required) |
--to string | which system to push to (default confluence) |
Aus facet wiki mirror --help (englische Originalhilfe)
Write a new page's header and scaffold
Aufruf
facet wiki new "Title" [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--bereich string | the area — the folder directly under wiki/ (required) |
--gruppe string | an optional group folder under the area |
--kategorie string | the page's category, from those wiki.yaml declares |
--records string | comma-separated record ids this page is about |
--registry string | which registry's wiki (default: the first declared) |
--summary string | the one line shown under the title in listings |
--tags string | comma-separated tags |
Aus facet wiki new --help (englische Originalhilfe)
Add or remove a page's tags, leaving everything else alone
Aufruf
facet wiki tag <path> [flags]
| Option | Funktion (englische Originalhilfe) |
|---|---|
--add string | comma-separated tags to add |
--registry string | which registry's wiki (default: the first declared) |
--remove string | comma-separated tags to remove |
Aus facet wiki tag --help (englische Originalhilfe)