Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.useswarm.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart

​
Prerequisites

  • Node.js 18+ installed
  • A running web app (local or deployed)
  • A Swarm account on the Pro plan

​
1. Install the CLI

npm install -g @useswarm/cli
Or with your preferred package manager: 
pnpm add -g @useswarm/cli
yarn global add @useswarm/cli
Verify the installation: 
swarm --version

​
2. Log in

swarm login
This opens your browser where you’ll authorize the CLI. Once approved, your credentials are stored locally and you’re ready to go.

​
3. Run your first test

Start your dev server, then run: 
swarm test --url localhost:3000 --goal "Sign up for an account"
Swarm will:
  1. Detect that the URL is local and open a tunnel automatically
  2. Ask you a few questions (audience, number of agents)
  3. Generate AI personas and start the test
  4. Stream results to your terminal in real time
You’ll also get a live dashboard link to monitor the test in your browser.

​
4. Review results

Once the test completes, you’ll see:
  • Individual persona results with UX scores
  • A synthesized executive summary
  • A judge verdict on whether the goal was achievable
  • Actionable tickets for issues found
Visit the dashboard link to see the full detailed report with step-by-step screenshots.

​
Next steps

MCP for AI editors

Run the full test → fix → retest loop from inside Claude Code, Codex, or Cursor. One command: npx @useswarm/mcp setup.

CLI Reference

Learn all available commands and flags.

Testing Local Apps

Tunneling, split frontend/backend setups, and authenticated testing.

Personas & Swarms

Create and reuse custom persona sets.

Authenticated Testing

Test flows that require login credentials.