Synced package doc

Quick Start

Get from zero to running AI agent prompts in under 5 minutes.

1. Install

npm install -g prompts-gpt

2. Check prerequisites

prompts-gpt doctor

This shows which providers are available and flags any issues.

3. Interactive quickstart (recommended)

prompts-gpt quickstart

The quickstart wizard walks you through:

  1. Entering your project token (from prompts-gpt.com)
  2. Pulling prompt packs from your project library
  3. Setting up local configuration
  4. Running your first sweep

4. Manual setup (alternative)

Save your token

prompts-gpt init --token pgpt_your_token_here

Pull prompt packs

prompts-gpt sync

This downloads prompts and generates agent files (AGENTS.md, .cursor/rules/, etc.).

Set up orchestration config

prompts-gpt setup

Creates .prompts-gpt/config.json with provider settings.

5. Run your first prompt

Single prompt execution

prompts-gpt run -f .prompts-gpt/my-prompt.md

Multi-iteration sweep

prompts-gpt sweep -f .prompts-gpt/sweeps/my-audit.md -n 3

Interactive mode

prompts-gpt sweep

Without flags, the CLI opens an interactive picker where you choose the sweep file, iteration count, provider, and model.

6. View results

prompts-gpt list

Shows all available prompts, sweep files, and agent integrations with runnable commands.

Minimal Local-Only Setup

You don't need a prompts-gpt.com account for local-only workflows:

# Create a sweep file manually
mkdir -p .prompts-gpt/sweeps
cat > .prompts-gpt/sweeps/code-review.md << 'EOF'
# Code Review

Review the codebase for bugs, security issues, and code quality problems.
Fix every issue found. Do not just report — implement the fix.

## Checklist
- [ ] Check for SQL injection vulnerabilities
- [ ] Verify error handling is comprehensive
- [ ] Ensure no hardcoded secrets
- [ ] Check for race conditions
EOF

# Run it
prompts-gpt sweep -f .prompts-gpt/sweeps/code-review.md -n 2

What's Next?

GoalCommandGuide
Run one promptprompts-gpt run -f <file>Run Command
Run multiple promptsprompts-gpt run-batch --prompt-files a.md,b.mdRun-Batch Command
Multi-iteration deep diveprompts-gpt sweep -f <file> -n 5Sweep Command
Compare providersprompts-gpt orchestrate --mode parallelOrchestrate Command
Sync agent filesprompts-gpt syncSync Command
Generate new promptsprompts-gpt generate --goal "..."Generate Command
Quick Start | prompts-gpt Documentation for Prompts-GPT.com | Prompts-GPT.com