getting started

Quick Start

Create your first PromptDoc in under 5 minutes with this hands-on guide.

Your First PromptDoc

Let's walk through creating a PromptDoc step by step. By the end, you'll have a structured spec ready to export.

Step 1: Start Recording

Launch Pinpoint and click the Record button (or press Cmd+Shift+R):

# Or start from the CLI
pinpoint record

You'll see a countdown before recording begins.

Step 2: Walk Through Your Workflow

With recording active, demonstrate what you want to build:

  1. Navigate to the relevant screens
  2. Click on elements you want to highlight
  3. Narrate your intentions (optional but recommended)

Pinpoint captures:

  • Every click and scroll
  • Screenshots at key moments
  • Your voice narration (transcribed automatically)

Step 3: Stop and Review

Press Cmd+Shift+S to stop recording. Pinpoint opens the editor showing your captured PromptDoc:

// Your PromptDoc structure
{
  blocks: [
    { type: "text", content: "Navigate to the settings page..." },
    { type: "image", src: "capture-001.png", annotations: [...] },
    { type: "checklist", items: ["Update user profile", "Save changes"] }
  ]
}

Step 4: Refine Your Spec

In the editor, you can:

  • Reorder blocks by dragging
  • Edit text and descriptions
  • Delete unnecessary captures
  • Add manual blocks for context

Step 5: Export

When you're happy with the PromptDoc, export it:

# Export as Markdown
pinpoint export --format markdown
 
# Export as JSON
pinpoint export --format json
 
# Copy to clipboard
pinpoint export --clipboard

What's Next