Documentation

<script src="https://spikes.sh/widget.js"></script>

curl -fsSL https://spikes.sh/install.sh | sh

cargo install spikes

# Inject widget into all HTML files in a directory
spikes inject ./mockups/

# Start local server
spikes serve
# → http://localhost:3847

# Share URL with reviewer, collect feedback, then:
spikes list                           # See all feedback
spikes list --rating no               # Find problems
spikes hotspots                       # Most-spiked elements
spikes list --json | jq '...'         # Feed to agents

# 1. Add the widget to your mockup
spikes inject ./mockups/

# 2. Open it in your browser
spikes serve
# → http://localhost:3847

# 3. See what needs fixing
spikes list --rating no
spikes list --rating meh

# 4. Feed structured data to your agent
spikes list --json

# Inject widget and serve locally
spikes inject ./mockups/
spikes serve
# Share http://your-ip:3847 with people on your network

# Scaffold and deploy a Cloudflare Worker
spikes deploy cloudflare
cd spikes-worker && npx wrangler deploy

# Inject widget into your HTML files
spikes inject ./mockups/
# Then add data-endpoint to the script tag in your HTML:
# <script src="/spikes.js" data-endpoint="https://your-worker.workers.dev/spikes"></script>

# Pull feedback from all reviewers
spikes pull

# See who reviewed and what they said
spikes reviewers
spikes list --reviewer "Sarah"

# Export everything for your agent
spikes list --json

# Paste this prompt into your agent:
Here is the feedback on my mockup. Fix each issue:
$(spikes list --json)

# Only fix negative feedback
spikes list --rating no --json

# Only fix feedback on a specific page
spikes list --page pricing.html --json

# Find the most-spiked elements first
spikes hotspots --json

# Export everything as CSV for a spreadsheet
spikes export --format csv > feedback.csv

#!/bin/bash
# Pull latest feedback and process with jq
spikes pull
spikes list --json | jq '.[] | select(.rating == "no")' | \
  jq -s '{issues: length, selectors: [.[].selector]}'

Create a .spikes/ directory in the current project to store feedback data.

Creates .spikes/feedback.jsonl for storing spike data (one spike per line).

List all feedback with optional filtering.

--json

Output as JSON array

--page <PAGE>

Filter by page URL or filename

--reviewer <NAME>

Filter by reviewer name

--rating <RATING>

Filter by rating (love, like, meh, no)

--unresolved

Show only unresolved spikes

# List all negative feedback
spikes list --rating no

# Get JSON for a specific page
spikes list --page index.html --json

Display details for a single spike.

--json

Output as JSON object

spikes show abc123xyz

Export all feedback in various formats for processing.

--format <FORMAT>

Output format: json, csv, jsonl (default: json)

# Export as CSV for spreadsheets
spikes export --format csv > feedback.csv

# Export as JSONL for streaming processing
spikes export --format jsonl

Find elements with the most feedback — useful for identifying problem areas.

--json

Output as JSON array

--limit <N>

Number of hotspots to show (default: 10)

spikes hotspots --limit 5 --json

List all reviewers who have submitted feedback.

--json

Output as JSON array

Add the Spikes widget script to HTML files in a directory.

--remove

Remove widget script tags instead of adding

--widget-url <URL>

URL for widget script (default: /spikes.js for local serve)

--json

Output as JSON

# Add widget to all HTML files in a directory
spikes inject ./mockups/

# Remove widget from all HTML files
spikes inject ./mockups/ --remove

Start a local development server for reviewing mockups.

--port <PORT>

Port to listen on (default: 3847)

--dir <DIR>

Directory to serve (default: current)

spikes serve --port 8080 --dir ./mockups/

Scaffold deployment configuration for your own backend.

cloudflare

Generate Cloudflare Worker + D1 scaffolding

# Generate Cloudflare Worker project
spikes deploy cloudflare
cd spikes-worker
npx wrangler deploy

Sync feedback with a remote endpoint.

--endpoint <URL>

Remote endpoint URL (or use SPIKES_API_URL env var)

# Fetch remote feedback
spikes pull --endpoint https://my-worker.workers.dev/spikes

# Upload local feedback
spikes push --endpoint https://my-worker.workers.dev/spikes

Delete a spike from local storage. Supports prefix matching (minimum 4 characters).

-f, --force

Skip confirmation prompt

--json

Output as JSON

spikes delete abc123
spikes delete abc1 --force

Mark a spike as resolved (or unresolved). Resolved spikes are excluded from spikes list --unresolved.

--unresolve

Mark as unresolved instead

--json

Output as JSON

spikes resolve abc123
spikes resolve abc123 --unresolve

Authenticate with spikes.sh via magic link. Token stored in ~/.config/spikes/auth.toml with 0600 permissions.

--token <TOKEN>

Auth token (or enter interactively)

--json

Output as JSON

Remove stored authentication for spikes.sh.

--json

Output as JSON

Show current user info and tier.

--json

Output as JSON

Upload a directory to spikes.sh for instant sharing.

--name <NAME>

Custom name for the share URL

--password <PASSWORD>

Password-protect the share (Pro only)

--host <HOST>

Host URL for the API (default: https://spikes.sh)

--json

Output as JSON

Delete a shared project from spikes.sh.

-f, --force

Skip confirmation prompt

--json

Output as JSON

spikes share ./mockups
spikes share ./mockups --name "design-review-v2"
spikes share ./mockups --password "secret123"
spikes unshare my-project

List your shared projects on spikes.sh.

--json

Output as JSON

Open Stripe billing portal in browser.

--json

Output as JSON

Show usage statistics (shares, spikes, limits).

--json

Output as JSON

Upgrade to Pro tier via Stripe checkout.

--json

Output as JSON

<script 
  src="https://spikes.sh/widget.js"
  data-project="my-project"
  data-position="bottom-left"
  data-color="#3498db"
  data-theme="dark"
  data-endpoint="https://my-worker.workers.dev/spikes"
  data-reviewer="alice"
  data-admin="true"
  data-offset-x="20px"
  data-offset-y="20px"
></script>

interface Spike {
  id: string;                    // nanoid
  type: "page" | "element";
  projectKey: string;
  page: string;
  url: string;
  reviewer: { id: string; name: string };
  selector?: string;             // Element spikes only
  elementText?: string;         // Element spikes only
  boundingBox?: { x, y, width, height };
  rating: "love" | "like" | "meh" | "no" | null;
  comments: string;
  timestamp: string;             // ISO 8601
  viewport: { width, height };
}

# Generate Cloudflare Worker scaffolding
spikes deploy cloudflare

# Deploy to your Cloudflare account
cd spikes-worker
npx wrangler deploy

<script 
  src="https://spikes.sh/widget.js" 
  data-endpoint="https://your-worker.workers.dev/spikes"
></script>

# Fetch all remote feedback
spikes pull

# Upload local feedback
spikes push

SPIKES_TOKEN=abc123 spikes whoami
SPIKES_API_URL=http://localhost:8787 spikes shares