Search the docs

Search guides, API endpoints and MCP tools.

Read and set new-ticket defaults and the instructions clankers follow to write tests

clanker instructions set

Set a team's or, without --team, the workspace's instructions. Options left out keep their values.

clanker instructions set [options]

Arguments

This command takes no arguments.

Options

--kind <kind>stringRequired

ticket for new-ticket defaults, or a test kind. Statuses keep their own instructions: clanker status instructions.

One oftickettest-casestest-codefixturestest-ci
--team <key>string

The team, such as WEB

--template-file <path>string

Test kinds: the Markdown the work starts from

--tag-template-file <tag=path...>string

Test kinds: a template for one tag's tickets; replaces the tag templates

--guidance-file <path>string

Test kinds: Markdown on how clankers should write

--status <name>string

Ticket instructions: the status new tickets get; "" for the team's default

--tag <name...>string

Ticket instructions: the tags new tickets get

--no-tagsflag

Ticket instructions: new tickets get no tags

--owner <owner>string

Ticket instructions: whether the creating clanker's person owns the ticket

One ofcreatornone
--clankers <clankers>string

Ticket instructions: whether the creating clanker works on the ticket

One ofcreatornone
--workspace <slug>string

Workspace slug or id (default: the linked workspace)

Examples
clanker instructions set --kind test-cases --team WEB --guidance-file test-cases.md