Search the docs

Search guides, API endpoints and MCP tools.

Create, change and move tickets, keep their checklists and documents, link their branches and pull requests, and send them to clankers

clanker ticket doc edit

Replace exact passages of a document as its next revision, all or none. Pair each --old with a --new.

clanker ticket doc edit [options] <id> <document>

Arguments

<id>stringRequired

The ticket's ID, such as WEB-31

<document>stringRequired

A document's name or slug, such as scope, plan or build-record

Options

--old <text...>stringRequired

A passage that appears exactly once in the document

--new <text...>stringRequired

What replaces the --old passage in the same place

--base-revision <n>string

The revision you read; the edit fails if it moved on

--workspace <slug>string

Workspace slug or id (default: the linked workspace)

Examples
clanker ticket doc edit WEB-31 plan --old "at build time" --new "at build time, skipping drafts"