designmdme

Generate a production-ready DESIGN.md design system spec from any website URL, straight from your terminal.

npx @crowdlinker/designmdme stripe.com

Installation

npm install -g @crowdlinker/designmdme

Usage

# Generate a DESIGN.md for any website
designmdme stripe.com
designmdme https://crowdlinker.com

# Specify a custom output path
designmdme stripe.com --output ./docs/DESIGN.md

# Choose the extraction mode (see "Extraction modes" below)
designmdme stripe.com --multi-page     # crawl key pages — richer output (8 credits)
designmdme stripe.com --single-page    # landing page only (4 credits)

# Also produce a standalone HTML preview alongside the markdown (8 credits)
designmdme stripe.com --html

# Authentication
designmdme login       # Open browser to authenticate
designmdme whoami      # Show current logged-in account
designmdme logout      # Remove stored credentials

# Credits, usage & recent transactions
designmdme usage

# Recent generations (also shows status of in-flight jobs)
designmdme list

Options

| Flag | Description | |------|-------------| | -o, --output <path> | Output file path (default: DESIGN-<hostname>.md) | | --multi-page | Crawl the site's key pages for richer output (8 credits) | | --single-page | Read only the landing page (4 credits) | | --html | Also generate an HTML design-system preview (8 credits) | | -w, --website <url> | Website URL (alias for the positional argument) |

Extraction modes

DESIGN.md can be generated from just the landing page, or from several of the site's key pages crawled together for a more complete design system.

• Single-page (4 credits) — reads only the URL you pass.
• Multi-page (8 credits) — discovers and reads the site's key pages (pricing, product, features, …) and merges them into one richer spec.

If you pass neither flag, the CLI uses your account's saved preference (set in the web app) and prints the resolved mode and cost before generating. Two things the CLI handles for you automatically:

• If your balance is below 8 credits, multi-page falls back to single-page rather than failing.
• If a site turns out to be a single route (no extra pages to crawl), you're billed the single-page rate (4 credits) even with --multi-page.

Authentication

Sign in with your DesignMD account to use your credit balance. Run designmdme login to open your browser — no password needed, just Google sign-in.

$ designmdme login

  DesignMD  CLI
  Generate DESIGN.md from any website

  Open this URL to authenticate:
  https://designmd.me/cli-auth?code=A4B7-X2K9

  Or enter the code manually at designmd.me/cli-auth
  Waiting for authentication...

  ✓ Logged in as [email protected]
  Token expires: Aug 4 2026

Credits & Usage

Run designmdme usage to see your credit balance, how many credits you've received and spent, generation counts, and your 10 most recent transactions.

$ designmdme usage

  Credits & Usage

  Available balance
  50 credits

  Credits used
  ▓▓▓▓▓░░░░░░░░░░░░░░░░░░░  12 / 62 received  (19%)

  Generations
  ────────────────────────────────────────
  All time                 7
  Last 30 days             7
  Last 7 days              3
  ────────────────────────────────────────

  Recent Transactions
  ────────────────────────────────────────
  + 50  Credits purchased         ($5.00)  2d ago
  −  4  Generation                · stripe.com  3d ago
  −  4  Generation                · vercel.com  4d ago
  −  4  Generation                · notion.so   6d ago
  + 10  Sign-up bonus              7d ago
  +  2  Welcome credits            7d ago
  ────────────────────────────────────────

  ⚡ designmd.me/pricing

Credits are consumed per generation — 4 for single-page, 8 for multi-page or an HTML preview. Purchase more at designmd.me/pricing. Credits are only charged when a generation succeeds — a cancelled or failed job never costs you anything, and re-generating a site that's already cached is free (the CLI prints "Served from cache · 0 credits").

Generating a DESIGN.md

$ designmdme stripe.com

  DesignMD  CLI
  Generate DESIGN.md from any website

  Multi-page extraction · 8 credits (single-route sites are billed as single-page)
  Scanning stripe.com…
  Queued — waiting for a worker…
  Generating DESIGN.md…

✓ Saved DESIGN-stripe-com.md

Generations run as durable background jobs on the server. The CLI shows the job status live (Queued → Generating) and waits for the result. This means:

• Leaving is safe. Press Ctrl+C (or close the terminal) and the job keeps running server-side — it isn't cancelled. The CLI just stops watching.
• Run designmdme list afterwards to see each job's status (● queued / ● processing / ● failed / ● cancelled, or a share link once ready) and, for jobs generated on this machine, the saved file path.
• Credits are only charged on success. To cancel a running job, use the web app's generation history.

If a file with the same name already exists, you'll be prompted:

⚠ DESIGN-stripe-com.md already exists.
  Replace or create a copy? (replace/copy): copy
✓ Saved DESIGN-stripe-com-20260507.md

Pointing the CLI at another environment

By default the CLI talks to production. The CLI uses two origins — the API server for all /api/* calls and the web app for the browser sign-in page (/cli-auth). Override both when testing against local or staging:

| Variable | Default | Purpose | |----------|---------|---------| | DESIGNMD_API_URL | https://api.designmd.me | API endpoints (analyze, generate, device auth, usage) | | DESIGNMD_WEB_URL | https://designmd.me | Browser sign-in page (/cli-auth) |

# Local dev: API on :3002, web app on :3011
export DESIGNMD_API_URL=http://localhost:3002
export DESIGNMD_WEB_URL=http://localhost:3011
designmdme login
designmdme stripe.com --single-page

Requirements

• Node.js 18 or later

License

MIT