3

Reference Commands Catalog and log

Wiki Mirror edited this page 2026-10-16 14:43:37 +00:00

Table of Contents

• Catalog and log
• Contents
• index rebuild
• log append
• log status

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Generated from docs/reference/commands/catalog-and-log.md at v10.1.0 – edit the repository, not this wiki.

Catalog and log

The generated catalog of the wiki and its append-only operations log.

Contents

• index rebuild
• log append
• log status

index rebuild

Regenerate the catalog from every page's frontmatter.

Synopsis

• wikitool index rebuild [--dry-run]

Options

  --dry-run   Print what would be written instead of writing it
  -h, --help  Show this message and exit.

Examples

tools/wikitool index rebuild
tools/wikitool index rebuild --dry-run

Behaviour

• Rewrites kb/index.md as a map: statistics, one row per collection and per area, and links to the shards - no page rows.
• Writes the page tables to a generated INDEX.md in each collection. An area with more than 50 rows gets its own INDEX.md in its directory.
• Deletes stale shards - an INDEX.md of a collection or area that no longer exists - in the same pass.
• Warns about every page nested more than one directory below its collection; it is still catalogued, folded into its area.
• --dry-run prints every file it would write and every stale shard it would remove, and writes nothing.

Properties

• Changes files: yes
• Idempotent: yes
• Atomic: No - each catalog file (the map plus one shard per collection/area) is rewritten independently, then stale shards are removed; an interruption can leave some regenerated and others not
• Counts toward the session call budget: yes
• Can reach the network: no

Exit codes

• 0 - success
• 1 - An I/O error while writing or removing a catalog file (rare)

See also

• wikitool search - finds a page without reading the catalog
• wikitool lint - its Nested Pages finding is what the warning previews
• instructions/publish-cycle.md - where a write session runs this

log append

Append a formatted entry to kb/log.md.

Synopsis

• wikitool log append --op ingest|query|lint|create|update|delete|rename|move --title "..." [--body "..."|--body-file path]

Options

  --op <str>          ingest|query|lint|create|update|delete|rename|move
                      [required]
  --title <str>       Brief description, e.g. a source path  [required]
  --body <str>        Optional multi-line details
  --body-file <path>  Read the body from a file instead of --body
  -h, --help          Show this message and exit.

Examples

tools/wikitool log append --op ingest --title "raw/articles/docker-cheatsheet.md" --body "Created [[Docker]]; updated [[Container]]."
tools/wikitool log append --op lint --title "2026-09-26" --body-file lint-summary.md

Behaviour

• Appends one entry to kb/log.md: a ## [YYYY-MM-DD] <op> | <title> heading, the body if one is given, and a --- separator.
• Not idempotent: every successful run appends a new entry, including a repeated one.

Properties

• Changes files: yes
• Idempotent: no
• Atomic: Yes - single append
• Counts toward the session call budget: yes
• Can reach the network: no

Exit codes

• 0 - success
• 1 - --op is not one of ingest, query, lint, create, update, delete, rename, move
• 1 - --body-file is missing, not a readable file, or not valid UTF-8

See also

• wikitool log status - counts the ingests logged since the last lint
• instructions/publish-cycle.md - where a write session runs this

log status

Read-only: count ingest entries logged since the last lint entry.

Synopsis

• wikitool log status

Options

  -h, --help  Show this message and exit.

Examples

tools/wikitool log status

Behaviour

• Counts the ingest entries in kb/log.md after the most recent lint entry, or since the start of the log if it was never linted, and the total number of entries.
• At 10 or more it prints that the wiki-lint skill is due next - the every-10-sources full lint of the Maintenance Schedule.
• Read-only; safe to retry freely.

Properties

• Changes files: no
• Idempotent: yes
• Atomic: Read-only
• Counts toward the session call budget: yes
• Can reach the network: no

Exit codes

• 0 - success
• 0 - kb/log.md is missing or empty - reported as nothing logged, not a failure

See also

• wikitool log append - writes the entries this counts
• wiki-lint skill - what the threshold asks for
• tools/CONTRACT.md § Maintenance schedule - the cadence this reports on

• Chemenu - Personal IT Knowledge Base
• Install a Chemenu instance
• Tutorials
  • From your first source to your first answer
  • Home lab backups - how they work now
• How-to guides
  • Back up to a synced folder
  • Browse the wiki in Obsidian
  • Capture documentation from a git repository
  • Collect documents from a synced folder
  • Export guidelines to captured repositories
  • Export to a synced folder
  • Fetch pages behind a login
  • Ingest a source
  • Maintain the wiki
  • Query the wiki
  • Run the weekly review
  • Set up the MCP read server
  • Trace and score agent sessions
  • Troubleshoot an instance
  • Update an instance
  • Use 1Password for settings
  • Write a site handler
• Reference
  • Command reference
    • Catalog and log
    • Configuration
    • Content migrations
    • Distribution and versioning
    • Exports
    • Finding and checking
    • Git
    • Instance health
    • Links and citations
    • Pages
    • Provenance
    • Raw material and uploads
    • Telemetry
    • Types, instructions and docs
    • Workshop runs and session budget
  • Configuration
  • Exit codes and gates
  • Page types
  • Skill catalogue
• Explanation
  • Architecture
  • Configuration tiers
  • Why knowledge and commitments are two layers
  • Language Boundaries
  • Choosing a Claude Code model and effort level
  • Ownership and Templates
  • Why the pipeline has four stages
  • Telemetry and evaluation
  • Why the stack version splits compatibility from migration
  • Why gates are code
• Dev
  • Developing this stack