Documentation menu

Quickstart

From install to your first archived change, in one pass.

The full path from zero to one completed, archived change. This assumes you've finished the Install page.

Before you start

  • Prompter is installed and `prompter whoami` shows your account.
  • You're at the root of a git-managed project.
  • Your AI coding agent is configured via `prompter init`.

Step by step

  1. See where things stand

    Before proposing anything, check which capabilities are already documented and which changes are in flight.

    prompter list --specs
    prompter list
  2. Ask your agent for a proposal

    Tell your AI agent what you want to build. The `proposal` skill writes proposal.md, tasks.md, and spec deltas — still no code.

    # inside your AI agent:
    "create a proposal for adding two-factor auth"
  3. Validate the proposal

    Strict mode catches missing deltas and malformed scenarios before any code is written.

    prompter validate add-two-factor-auth --strict --no-interactive
  4. Approve, then implement

    Read the proposal yourself. Once you're satisfied, have the agent run the `apply` skill, which works through tasks.md in order.

    prompter show add-two-factor-auth
  5. Archive it

    The change moves to changes/archive/ and its deltas are folded into the main specs. From now on, the specs reflect reality.

    prompter archive add-two-factor-auth --yes

What you end up with

A documented requirement in `prompter/specs/`, an audit trail in `prompter/changes/archive/`, and code that traces back to the reason it was written. All of it plain text inside your repo.

Last updated: May 16, 2026