chemenu/docs/reference/commands

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.

Contents

• Pages
• Links and citations
• Catalog and log
• Finding and checking
• Provenance
• Raw material and uploads
• Git
• Exports
• Workshop runs and session budget
• Types, instructions and docs
• Telemetry
• Distribution and versioning
• Content migrations
• Configuration
• Instance health

Pages

Full records: pages.md

• new - Scaffold a new wiki page of any type.
• task new - Create one open item in the configured task tracker - never a kb/ page.
• task list - List a project's open items - id, title, and whether each carries the WAITING status.
• task close - Mark one tracker item done - never delete it.
• touch - Bump a page's modified: date and optionally rewrite its other frontmatter fields.
• rename - Rename a page, or repoint references that name a page that never existed.
• rm - Delete a page and mechanically de-link it from the rest of the wiki.
• move - Move a page (or every misplaced page) to the directory its type-spec computes.

Links and citations

Full records: links-and-citations.md

• xref add - Declare that A B.
• xref remove - Remove a cross-reference: the inverse of xref add.
• xref link-source - Batch-link a source page to every entity/concept it mentions.
• links show - Show the edges out of and into a page.
• cite id - Print the deterministic footnote id cite add would use for this (title, file) pair.
• cite add - Upsert a [^cite-id]: [[Source - X]] definition in a page's footnotes region.
• cite sync - Reconcile each page's footnotes region against its actual [^id] references.

Catalog and log

Full records: catalog-and-log.md

• index rebuild - Regenerate the catalog from every page's frontmatter.
• log append - Append a formatted entry to kb/log.md.
• log status - Read-only: count ingest entries logged since the last lint entry.

Finding and checking

Full records: finding-and-checking.md

• lint - Run structural lint checks against kb/.
• search - Find pages in kb/ by text and/or frontmatter.
• review - The GTD weekly review.

Provenance

Full records: provenance.md

• sources coverage - List raw files with no source page, broken raw_files: references, and legacy directory/URL-only source pages.
• sources trace - Trace provenance in either direction: raw file, or page.
• sources rebuild-index - Regenerate the kb/provenance.md reverse index.

Raw material and uploads

Full records: 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 - 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 - 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 - 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 - Report which captured bundles under raw/ have fallen behind their repository, with each changed file as A/M/D.
• raw pending - List what waits in incoming/, oldest first, and name the entry an ingest without an argument takes next.
• raw accept - Promote one or more files, or one folder, from incoming/ into raw/.
• upload collect - Pull material from the configured folder and command intake channels into the quarantine - never past it.
• upload list - List every submission currently waiting in the quarantine (quarantine/), whatever channel it came through.
• upload show - Print one submission's manifest in full.
• upload accept - Upload Review Gate: promote a submission's file from quarantine into incoming/.
• upload reject - Delete a submission's material, keeping only its ledger trail.

Git

Full records: git.md

• sync - Fetch <remote>/<branch> and bring the local branch up to date with it.
• publish - Reconcile with <remote>/<branch>, then stage all changes, commit, and push.
• backup init - Create the backup target's bare repository and make it origin when there is none.
• backup run - Mirror this machine's files that are not in git into <target>/<machine>/.

Exports

Full records: 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 - 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

• work new - Scaffold work/<runkey>/ for one workshop run.
• work close - Delete a finished workshop.
• budget status - Show the current session's wikitool call count and recent command history.
• 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 list - List every type-spec under types/.
• types describe - Print one type's full contract.
• instructions sync - Publish every instructions/<name>/SKILL.md into the harness skill directories.
• instructions verify - Check the instruction layer.
• instructions list - List the flat instructions with their descriptions.
• docs verify - Check the docs that mirror the code.
• docs toc - Create, refresh or remove the generated table-of-contents region.
• docs prerequisites - Regenerate INSTALL.md's prerequisites lists from tools/prerequisites.txt.
• docs contract - Regenerate tools/CONTRACT.md's <!-- wikitool:commands --> region.
• docs reference - Regenerate the human reference under docs/reference/.

Telemetry

Full records: telemetry.md

• eval sessions - List the sessions that have a trace under reports/telemetry/.
• eval score - Score one traced session.

Distribution and versioning

Full records: distribution-and-versioning.md

• dist export - Write a contentless, distributable copy of this repo's machinery.
• dist adopt - Take shipped templates as this instance's own: copy each to its unsuffixed name.
• dist upgrade - Apply a stack update dist export produced - the write half of version check.
• version show - Print this instance's stack version and where it came from.
• version check - Ask the origin's release feed whether a newer stack exists.
• version notes - Print one version's release notes.
• version bump - Raise or continue the one running candidate between two releases.
• version regrade - List the running candidate's bump titles with their impact grade, or change one or more of them.
• 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

• migrate list - List every migration document under instructions/migrations/.
• migrate status - Show the migrations this instance still owes, in the order they must run.
• migrate verify - Compare kb/ against a git revision on the invariants a content migration must not change.
• migrate done - Record one migration as applied, advancing kb_version in .wikitool-kb.json.
• migrate baseline - Declare kb_version once, for an instance predating .wikitool-kb.json.

Configuration

Full records: configuration.md

• config set - Set one value of the tiered settings, in the file its tier names.
• 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

• doctor - Check that this instance is correctly configured.