torbenandClaude Code
99945c4841
Files changed: - CHANGES.md - VERSION - docs/how-to/README.md - docs/how-to/back-up-to-a-synced-folder.md - docs/how-to/collect-from-a-synced-folder.md - docs/how-to/export-guidelines.md - docs/how-to/export-to-a-synced-folder.md - docs/reference/commands/README.md - docs/reference/commands/exports.md - docs/reference/commands/git.md - docs/reference/commands/guideline-export.md - docs/reference/commands/instance-health.md - docs/reference/commands/raw-material-and-uploads.md - docs/reference/configuration.md - docs/reference/exit-codes.md - instructions/setup-instance.md - raw/CONTRACT.md - tools/CONTRACT.md - tools/README.md - tools/chemenu/backup.py - tools/chemenu/cli_contract.py - tools/chemenu/commands/doctor.py - tools/chemenu/commands/export_cmd.py - tools/chemenu/commands/git_publish.py - tools/chemenu/commands/raw/_common.py - tools/chemenu/commands/raw/accept.py - tools/chemenu/commands/raw/capture.py - tools/chemenu/config_shapes.py - tools/chemenu/guideline_export.py - tools/chemenu/page_export.py - tools/chemenu/reference_doc.py - tools/chemenu/repo_capture.py - tools/chemenu/tests/test_config_shapes.py - tools/chemenu/tests/test_export_run.py Co-Authored-By: Claude Code <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
179 lines
12 KiB
Markdown
179 lines
12 KiB
Markdown
# Command reference
|
|
|
|
Every `wikitool` command, one page per group, generated from the same records `tools/wikitool
|
|
<command> -h` prints. Each command's section gives its synopsis, options, examples, behaviour,
|
|
properties and exit codes; what a command exits 42 for, and which gate it belongs to, is
|
|
collected in [exit codes and gates](../exit-codes.md).
|
|
|
|
<!-- wikitool:toc -->
|
|
## Contents
|
|
|
|
- [Pages](#pages)
|
|
- [Links and citations](#links-and-citations)
|
|
- [Catalog and log](#catalog-and-log)
|
|
- [Finding and checking](#finding-and-checking)
|
|
- [Provenance](#provenance)
|
|
- [Raw material and uploads](#raw-material-and-uploads)
|
|
- [Git](#git)
|
|
- [Exports](#exports)
|
|
- [Workshop runs and session budget](#workshop-runs-and-session-budget)
|
|
- [Types, instructions and docs](#types-instructions-and-docs)
|
|
- [Telemetry](#telemetry)
|
|
- [Distribution and versioning](#distribution-and-versioning)
|
|
- [Content migrations](#content-migrations)
|
|
- [Configuration](#configuration)
|
|
- [Instance health](#instance-health)
|
|
<!-- /wikitool:toc -->
|
|
|
|
<!-- wikitool:reference-commands-index -->
|
|
## Pages
|
|
|
|
Full records: [pages.md](pages.md)
|
|
|
|
- [`new`](pages.md#new) - Scaffold a new wiki page of any type.
|
|
- [`task new`](pages.md#task-new) - Create one open item in the configured task tracker - never a kb/ page.
|
|
- [`task list`](pages.md#task-list) - List a project's open items - id, title, and whether each carries the WAITING status.
|
|
- [`task close`](pages.md#task-close) - Mark one tracker item done - never delete it.
|
|
- [`touch`](pages.md#touch) - Bump a page's `modified:` date and optionally rewrite its other frontmatter fields.
|
|
- [`rename`](pages.md#rename) - Rename a page, or repoint references that name a page that never existed.
|
|
- [`rm`](pages.md#rm) - Delete a page and mechanically de-link it from the rest of the wiki.
|
|
- [`move`](pages.md#move) - Move a page (or every misplaced page) to the directory its type-spec computes.
|
|
|
|
## Links and citations
|
|
|
|
Full records: [links-and-citations.md](links-and-citations.md)
|
|
|
|
- [`xref add`](links-and-citations.md#xref-add) - Declare that A <rel> B.
|
|
- [`xref remove`](links-and-citations.md#xref-remove) - Remove a cross-reference: the inverse of `xref add`.
|
|
- [`xref link-source`](links-and-citations.md#xref-link-source) - Batch-link a source page to every entity/concept it mentions.
|
|
- [`links show`](links-and-citations.md#links-show) - Show the edges out of and into a page.
|
|
- [`cite id`](links-and-citations.md#cite-id) - Print the deterministic footnote id `cite add` would use for this (title, file) pair.
|
|
- [`cite add`](links-and-citations.md#cite-add) - Upsert a `[^cite-id]: [[Source - X]]` definition in a page's footnotes region.
|
|
- [`cite sync`](links-and-citations.md#cite-sync) - Reconcile each page's footnotes region against its actual `[^id]` references.
|
|
|
|
## Catalog and log
|
|
|
|
Full records: [catalog-and-log.md](catalog-and-log.md)
|
|
|
|
- [`index rebuild`](catalog-and-log.md#index-rebuild) - Regenerate the catalog from every page's frontmatter.
|
|
- [`log append`](catalog-and-log.md#log-append) - Append a formatted entry to `kb/log.md`.
|
|
- [`log status`](catalog-and-log.md#log-status) - Read-only: count `ingest` entries logged since the last `lint` entry.
|
|
|
|
## Finding and checking
|
|
|
|
Full records: [finding-and-checking.md](finding-and-checking.md)
|
|
|
|
- [`lint`](finding-and-checking.md#lint) - Run structural lint checks against kb/.
|
|
- [`search`](finding-and-checking.md#search) - Find pages in `kb/` by text and/or frontmatter.
|
|
- [`review`](finding-and-checking.md#review) - The GTD weekly review.
|
|
|
|
## Provenance
|
|
|
|
Full records: [provenance.md](provenance.md)
|
|
|
|
- [`sources coverage`](provenance.md#sources-coverage) - List raw files with no source page, broken `raw_files:` references, and legacy directory/URL-only source pages.
|
|
- [`sources trace`](provenance.md#sources-trace) - Trace provenance in either direction: raw file, or page.
|
|
- [`sources rebuild-index`](provenance.md#sources-rebuild-index) - Regenerate the `kb/provenance.md` reverse index.
|
|
|
|
## Raw material and uploads
|
|
|
|
Full records: [raw-material-and-uploads.md](raw-material-and-uploads.md)
|
|
|
|
- [`raw fetch`](raw-material-and-uploads.md#raw-fetch) - Capture a web page the user names into `incoming/`: the HTML as received plus a derived text, for `raw accept` to promote. Pages of a known website are fetched in the website's standard form and cleaned of its page furniture; a host the instance routes so is fetched with the user's own session or through an external fetcher.
|
|
- [`raw login`](raw-material-and-uploads.md#raw-login) - Let the user sign in to a website once, in a visible browser window, and store the session it leaves as a secret outside the working tree, for `raw fetch` to fetch that website's pages with. Only the user runs it.
|
|
- [`raw derive`](raw-material-and-uploads.md#raw-derive) - Derive reading text from a PDF, e-mail, Office file or web page in `incoming/`, or unpack a ZIP, and leave the original beside it, for `raw accept` to promote.
|
|
- [`raw capture`](raw-material-and-uploads.md#raw-capture) - Capture documentation from a git repository into `incoming/<bundle>/`, with a manifest naming the repository, ref rule and commit, for `raw accept` to promote.
|
|
- [`raw status`](raw-material-and-uploads.md#raw-status) - Report which captured bundles under `raw/` have fallen behind their repository, with each changed file as `A`/`M`/`D`.
|
|
- [`raw pending`](raw-material-and-uploads.md#raw-pending) - List what waits in `incoming/`, oldest first, and name the entry an ingest without an argument takes next.
|
|
- [`raw accept`](raw-material-and-uploads.md#raw-accept) - Promote one or more files, or one folder, from `incoming/` into `raw/`.
|
|
- [`upload collect`](raw-material-and-uploads.md#upload-collect) - Pull material from the configured `folder` and `command` intake channels into the quarantine - never past it.
|
|
- [`upload list`](raw-material-and-uploads.md#upload-list) - List every submission currently waiting in the quarantine (`quarantine/`), whatever channel it came through.
|
|
- [`upload show`](raw-material-and-uploads.md#upload-show) - Print one submission's manifest in full.
|
|
- [`upload accept`](raw-material-and-uploads.md#upload-accept) - **Upload Review Gate:** promote a submission's file from quarantine into `incoming/`.
|
|
- [`upload reject`](raw-material-and-uploads.md#upload-reject) - Delete a submission's material, keeping only its ledger trail.
|
|
|
|
## Git
|
|
|
|
Full records: [git.md](git.md)
|
|
|
|
- [`sync`](git.md#sync) - Fetch `<remote>/<branch>` and bring the local branch up to date with it.
|
|
- [`publish`](git.md#publish) - Reconcile with `<remote>/<branch>`, then stage all changes, commit, and push.
|
|
- [`backup init`](git.md#backup-init) - Create the backup target's bare repository and make it `origin` when there is none.
|
|
- [`backup run`](git.md#backup-run) - Mirror this machine's files that are not in git into `<target>/<machine>/`.
|
|
|
|
## Exports
|
|
|
|
Full records: [exports.md](exports.md)
|
|
|
|
- [`export guidelines`](exports.md#export-guidelines) - Render the guideline pages into one generated `GUIDELINES.md`, or push it into the captured repositories that opted in (**Guideline Push Gate**).
|
|
- [`export run`](exports.md#export-run) - Write the derived, read-only reading copy of `kb/` into the folders the `export` section configures - the selected pages as Markdown, or converted by a program of this checkout.
|
|
|
|
## Workshop runs and session budget
|
|
|
|
Full records: [workshop-runs-and-session-budget.md](workshop-runs-and-session-budget.md)
|
|
|
|
- [`work new`](workshop-runs-and-session-budget.md#work-new) - Scaffold `work/<runkey>/` for one workshop run.
|
|
- [`work close`](workshop-runs-and-session-budget.md#work-close) - Delete a finished workshop.
|
|
- [`budget status`](workshop-runs-and-session-budget.md#budget-status) - Show the current session's `wikitool` call count and recent command history.
|
|
- [`budget reset`](workshop-runs-and-session-budget.md#budget-reset) - Clear the current session's (or every session's) iteration budget state.
|
|
|
|
## Types, instructions and docs
|
|
|
|
Full records: [types-instructions-and-docs.md](types-instructions-and-docs.md)
|
|
|
|
- [`types list`](types-instructions-and-docs.md#types-list) - List every type-spec under `types/`.
|
|
- [`types describe`](types-instructions-and-docs.md#types-describe) - Print one type's full contract.
|
|
- [`instructions sync`](types-instructions-and-docs.md#instructions-sync) - Publish every `instructions/<name>/SKILL.md` into the harness skill directories.
|
|
- [`instructions verify`](types-instructions-and-docs.md#instructions-verify) - Check the instruction layer.
|
|
- [`instructions list`](types-instructions-and-docs.md#instructions-list) - List the flat instructions with their descriptions.
|
|
- [`docs verify`](types-instructions-and-docs.md#docs-verify) - Check the docs that mirror the code.
|
|
- [`docs toc`](types-instructions-and-docs.md#docs-toc) - Create, refresh or remove the generated table-of-contents region.
|
|
- [`docs prerequisites`](types-instructions-and-docs.md#docs-prerequisites) - Regenerate `INSTALL.md`'s prerequisites lists from `tools/prerequisites.txt`.
|
|
- [`docs contract`](types-instructions-and-docs.md#docs-contract) - Regenerate `tools/CONTRACT.md`'s `<!-- wikitool:commands -->` region.
|
|
- [`docs reference`](types-instructions-and-docs.md#docs-reference) - Regenerate the human reference under `docs/reference/`.
|
|
|
|
## Telemetry
|
|
|
|
Full records: [telemetry.md](telemetry.md)
|
|
|
|
- [`eval sessions`](telemetry.md#eval-sessions) - List the sessions that have a trace under `reports/telemetry/`.
|
|
- [`eval score`](telemetry.md#eval-score) - Score one traced session.
|
|
|
|
## Distribution and versioning
|
|
|
|
Full records: [distribution-and-versioning.md](distribution-and-versioning.md)
|
|
|
|
- [`dist export`](distribution-and-versioning.md#dist-export) - Write a contentless, distributable copy of this repo's machinery.
|
|
- [`dist adopt`](distribution-and-versioning.md#dist-adopt) - Take shipped templates as this instance's own: copy each to its unsuffixed name.
|
|
- [`dist upgrade`](distribution-and-versioning.md#dist-upgrade) - Apply a stack update `dist export` produced - the write half of `version check`.
|
|
- [`version show`](distribution-and-versioning.md#version-show) - Print this instance's stack version and where it came from.
|
|
- [`version check`](distribution-and-versioning.md#version-check) - Ask the origin's release feed whether a newer stack exists.
|
|
- [`version notes`](distribution-and-versioning.md#version-notes) - Print one version's release notes.
|
|
- [`version bump`](distribution-and-versioning.md#version-bump) - Raise or continue the one running candidate between two releases.
|
|
- [`version regrade`](distribution-and-versioning.md#version-regrade) - List the running candidate's bump titles with their impact grade, or change one or more of them.
|
|
- [`version release`](distribution-and-versioning.md#version-release) - Fix the running candidate: strip `VERSION`'s `-beta.N` suffix and close its `CHANGES.md` entry.
|
|
|
|
## Content migrations
|
|
|
|
Full records: [content-migrations.md](content-migrations.md)
|
|
|
|
- [`migrate list`](content-migrations.md#migrate-list) - List every migration document under `instructions/migrations/`.
|
|
- [`migrate status`](content-migrations.md#migrate-status) - Show the migrations this instance still owes, in the order they must run.
|
|
- [`migrate verify`](content-migrations.md#migrate-verify) - Compare `kb/` against a git revision on the invariants a content migration must not change.
|
|
- [`migrate done`](content-migrations.md#migrate-done) - Record one migration as applied, advancing `kb_version` in `.wikitool-kb.json`.
|
|
- [`migrate baseline`](content-migrations.md#migrate-baseline) - Declare `kb_version` once, for an instance predating `.wikitool-kb.json`.
|
|
|
|
## Configuration
|
|
|
|
Full records: [configuration.md](configuration.md)
|
|
|
|
- [`config set`](configuration.md#config-set) - Set one value of the tiered settings, in the file its tier names.
|
|
- [`config migrate`](configuration.md#config-migrate) - Move the settings out of the per-feature files of earlier versions into the tiered settings.
|
|
|
|
## Instance health
|
|
|
|
Full records: [instance-health.md](instance-health.md)
|
|
|
|
- [`doctor`](instance-health.md#doctor) - Check that this instance is correctly configured.
|
|
<!-- /wikitool:reference-commands-index -->
|