update

livewiki update command

The livewiki update command records incremental documentation work and emits a focused package for the next update.

When to use this page

• Run livewiki update to calculate documentation changes since the last documented commit.
• Configure the snippet window passed to the work-package loader.
• Record an estimated token count after documentation has been written back.
• Learn how the command emits human-readable or JSON output.

How it fits

packages/cli/src/commands/update.ts registers the update subcommand on the Commander CLI. It coordinates the root resolver, output emitter, status runner, and incremental-update services provided by @livewiki/core/update.

The default flow calls loadWorkPackage to gather debt, snippets, valid anchors, and impact data. Separate option branches record documentation written back or indicate that --llm requires the batch workflow; neither branch emits the default work package.

Diagram

%% livewiki/diagrams/commands-update.mmd

Registering and routing the command

registerUpdate attaches the incremental documentation command and its action to the existing CLI program.

export function registerUpdate(program: Command): void

This function takes the root Commander program and returns no value; it modifies the program by adding the update subcommand and its options.

The action resolves repoRoot from the current working directory and resolveRepoRoot. It then selects one of three visible paths:

1. --record-write <tokens> parses a decimal integer and rejects a negative or non-numeric value by writing an error to stderr, setting exit code 1, and returning without producing a work package.
2. --llm writes a message directing the user to the batch workflow, sets exit code 1, and returns without calling the configured API from this command.
3. The default path parses --snippet-window <lines> or uses 20, then passes only a positive finite value as snippetWindow to loadWorkPackage.