Quick Start

Get started with PlanSpec using Claude Code.

Prerequisites

Install PlanSpec CLI

Option 1: Cargo (recommended)

If you have Rust installed:

bash
cargo install planspec

Option 2: GitHub Releases

Download the latest release for your platform from GitHub Releases.

Create Your First Plan

Create a file called plan.yaml:

yaml
apiVersion: planspec.io/v1alpha1
kind: Goal
metadata:
  name: my-first-goal
  namespace: default
spec:
  description: Build a simple hello world application
  acceptanceCriteria:
    - description: Application prints "Hello, World!" when run
    - description: Code is well-documented
---
apiVersion: planspec.io/v1alpha1
kind: Plan
metadata:
  name: my-first-plan
  namespace: default
spec:
  description: Implementation plan for hello world application
  goalRef:
    name: my-first-goal
  graph:
    nodes:
      - id: create-app
        kind: Task
        description: Create the main application file
        acceptanceCriteria:
          - type: artifact_exists
            name: Main file exists
            path: src/main.py
            contentMatch: "print.*Hello"
      - id: add-docs
        kind: Task
        description: Add documentation
        dependsOn:
          - create-app
        acceptanceCriteria:
          - type: artifact_exists
            name: README exists
            path: README.md

Validate Your Plan

Use the CLI to validate your plan:

bash
planspec validate plan.yaml

Use with Claude Code

PlanSpec integrates directly with Claude Code. When working with Claude:

  1. Share your plan file with Claude
  2. Claude will understand the structure and help execute tasks
  3. Track progress through acceptance criteria

Try the Playground to experiment with PlanSpec schemas interactively.

Next Steps