Skip to main content

Update specs and Scratchpad files from your coding agent

Write a project's summary, outcomes, or requirements from the CLI, and add notes and mockups to its Scratchpad.

Written by Jack Meyers

Your coding agent can write a project's plan documents and add files to its Scratchpad. Use this when your product lead asks you to, or for projects you plan yourself.

Write or comment?

The product lead owns the plan. If your build would differ from the plan, raise a thread instead of editing the plan, unless the product lead asked you to make that edit. See Ask the product lead instead of guessing.

grove project view repeats this rule, so your coding agent sees it before it writes.

Write the plan documents

Command

What it replaces

grove project summary write P-003

The whole summary.

grove project outcomes write P-003

Only the outcomes list in the summary. The rest of the summary stays.

grove project requirements write P-003

The whole Requirements document.

Send the document on standard input, or with --from-file:

grove project requirements write P-003 --from-file requirements.md

The command replaces the whole document. Send the full document, not just the changed part.

Grove checks the document

Grove checks each document against its standard: the same rules Grove follows when it writes one. If a document doesn't meet the standard, Grove says why, quotes the standard, and writes nothing.

The standards are in .grove/standards/index.json after you pick up a project. Have your agent read the standard before it writes a document of that kind.

If the summary has no outcomes, Grove tells you. A project needs at least one outcome before it's ready to build.

What the product lead sees

Your edits show as yours. Grove saves a version before and after each change, so your product lead can see what changed in the document's version history. See See and restore earlier versions.

Add a Scratchpad file

A project's Scratchpad holds what the work turned up: research, findings, and mockups. See Use the Scratchpad.

grove artifact create P-003 --kind document --name "Calendar API findings" --from-file findings.md
grove artifact create P-003 --kind visual --name "Move screen sketch" --from-file move-screen.html

Kind

What it is

Where it lands

document

A Markdown write-up. The name is the title, so don't repeat it as a heading.

<name>.md

visual

One self-contained HTML file. Scripts, styles, images, and fonts go inside the file. Nothing loads from the network.

assets/<name>.html

Outcomes and rules don't go in the Scratchpad. Outcomes go in the summary, and rules go in the requirements.

Read or change a Scratchpad file

grove file list
grove artifact read assets/move-screen-sketch.html
grove artifact revise findings.md --from-file findings.md
grove artifact revise findings.md --section "Open questions" --from-file open-questions.md
  • grove file list shows the paths.

  • grove artifact revise replaces the whole file. With --section, it replaces only the part under one heading, in a document.

  • --name renames the file. Its path stays the same.

An archived project's Scratchpad can't be changed.

Related articles

Did this answer your question?