Skip to main content
manual page/ Reference

Cheatsheet

sourceSource: suspec/docs/reference/cheatsheet.mdModified: 2026-06-30
Sections
9
Format
Markdown
Order
23 / 156

Loop

code
Pull -> (Inventory) -> Spec -> (Change Plan) -> Task -> Run -> Review -> Close

Files

StepFile
Pullintake/*.md
Inventoryinventory/*.md
Specspecs/<feature>/spec.md
Change Planchange-plans/*.md
Tasktasks/*.md
Runspec ## Execution (default), or task ## Run summary
Reviewreviews/*.md
Closefindings/*.md, status.md

Requirement

code
### AC-001 - Short name

The system must do one observable thing.

Verify with: `command`

Rules:

  • one behavior
  • one binding word
  • one verify line
  • uncertainty goes to Open questions

Results

Four core results:

ResultMeaning
Passevidence shows requirement is met
Failevidence shows requirement is not met
Unverifiedevidence is missing or insufficient
Blockedcannot judge yet

Empty evidence means Unverified.

Three lifecycle markers (decorate a prior result, never a core value — advanced lifecycle):

MarkerMeaning
Waiveda Fail/Unverified accepted by the owner, with reason and expiry
Stalea prior Pass no longer trusted after the text or evidence path changed
Contradictedevidence conflicts

Merge gate: every in-scope requirement is Pass or a live Waived, and none is Stale, Contradicted, Fail, Blocked, or Unverified. An empty scope does not pass.

Evidence

Valid:

  • pasted command output
  • CI link
  • named manual observation

Invalid:

  • tests passed
  • worker summary alone
  • unsupported screenshot

Review triggers

Route to Human attention:

  • Fail, Unverified, Blocked
  • out-of-scope edits
  • Do not change touched
  • risky files
  • public interface changes
  • migrations
  • security-sensitive changes
  • missing test output
  • candidate findings
  • blocked questions

Core checks

IDName
C001unique-ids
C002duplicate-id
C003verify-with
C004one-strength-word
C005non-goals-present
C006open-questions-present
C007no-tbd-at-ready
C008sources-named
C009broken-source-link
C010preserves-refs-resolve
C011waves-present
C012coverage
C013verify-evidence-binding
C014do-not-change-touched
C015citation-resolves
C016pass-needs-evidence
C017orphaned-reference

See checks.

Workspace names

Dedicated workspace repo:

code
<project>-works

Code repo pointer:

code
Suspec workspace: ../<project>-works. Read the task packet before coding.

CLI

Common commands:

code
suspec init
suspec update --check
suspec check
suspec new spec <slug>
suspec new task --from SPEC-id --scope AC-001
suspec worktree create TASK-id
suspec run TASK-id --agent codex
suspec review TASK-id
suspec status

CLI prepares and reconciles. It does not write code or decide correctness.

Starter kit: Set up a workspace