View as Markdown

Tutorial: three steps

Tip

In five commands you get a spec.toml, a document that governs a code path, and a passing spec check. Install first: Install.

The steps

  1. Write. spec init writes a starter spec.toml; spec new stores a document with the owner of the code it governs.
  2. Link. --governs records the code path. spec context now lists the document for any file under it.
  3. Check. spec check runs the rules. spec agents prints the lines for an agent’s instruction file.

Run it

$ spec init --owner 'services/*={1}' --write
$ spec new sot --governs services/shop/src/cart --title "Cart totals"
$ spec context services/shop/src/cart/total.rs
$ spec check
$ spec agents --for claude

What happened

The --owner pattern makes every directory under services/ an owner, so the document lands in services/shop/.spec/sot/. Its id, sot:shop/cart-totals, comes from that place.

spec context answers the question an agent or reviewer asks first: which documents must I read before changing this file?

Next