Synced package doc
Docs/prompts-gpt Package/Installation

Installation

npm (recommended)

npm install -g prompts-gpt

Or as a project dev dependency:

npm install --save-dev prompts-gpt

npx (no install)

Run any command without installing:

npx prompts-gpt doctor
npx prompts-gpt sweep -f my-prompt.md -n 3

pnpm

pnpm add -g prompts-gpt
# or
pnpm add -D prompts-gpt

yarn

yarn global add prompts-gpt
# or
yarn add -D prompts-gpt

Verify Installation

prompts-gpt version
prompts-gpt doctor

The doctor command checks:

  • Node.js version (requires ≥ 18.18)
  • OS platform and architecture
  • CPU count
  • Configuration file presence
  • All provider CLIs (Codex, Claude, Cursor, Copilot) — availability and version

Provider CLIs

prompts-gpt delegates execution to local agent CLIs. Install at least one:

OpenAI Codex

npm install -g @openai/codex

Authentication: Log in via codex or set OPENAI_API_KEY.

Claude Code (Anthropic)

npm install -g @anthropic-ai/claude-code

Authentication: Log in via claude or set ANTHROPIC_API_KEY.

Cursor

Cursor CLI is bundled with Cursor IDE. Ensure the cursor binary is in your PATH.

GitHub Copilot

# Install GitHub CLI first
brew install gh  # macOS
# Then install Copilot extension
gh extension install github/gh-copilot

Shell Completions

Enable tab completion for faster CLI usage:

# Bash
eval "$(prompts-gpt completions bash)"

# Zsh
eval "$(prompts-gpt completions zsh)"

# Fish
prompts-gpt completions fish > ~/.config/fish/completions/prompts-gpt.fish

# PowerShell
prompts-gpt completions powershell >> $PROFILE

Add the appropriate line to your shell profile (.bashrc, .zshrc, etc.) for persistent completions.

Next Steps