npm package

prompts-gpt package docs

This page now reads from the package documentation in the repo, so the website and the published package docs stay aligned.

View on npmAll docs
Install and quickstart
# Install
npm install -D prompts-gpt

# Interactive setup — handles credentials, config, and shows runnable commands
npx prompts-gpt quickstart
Remote setup
npm install -D prompts-gpt
npm install -g @openai/codex
Synced from `packages/prompts-gpt/docs`

Browse the full package documentation

The sections below are generated from the package docs index. Individual pages are rendered directly from the markdown files in this repository.

Getting Started

New to prompts-gpt? Start here.

Introduction

What is prompts-gpt, key features, architecture

Installation

npm install, provider CLIs, shell completions

Quick Start

First prompt in 5 minutes

Authentication

Tokens, credentials, CI/CD setup

CLI Reference

Complete reference for every CLI command.

init

Save project token

setup

Scaffold config.json

quickstart

Interactive first-run wizard

doctor

Validate prerequisites

sync

Pull + write prompts + agent files

pull

Download prompt packs from API

generate

AI-generate a prompt from a goal

generate-sweep

Scaffold sweep files

generate-orchestration

Scaffold orchestration files

run

Execute a single prompt

run-batch

Execute multiple prompts

sweep

Multi-iteration sweep execution

orchestrate

Multi-agent orchestration

list

List workspace assets

status

Show workspace readiness

diff

Show worktree changes

validate

Validate config and prompts

project

Show linked project info

providers

List detected provider CLIs

models

Manage models per provider

sync-models

Update model registry

completions

Generate shell tab-completion

SDK / API Reference

Programmatic access to all prompts-gpt functionality.

SDK Overview

Module structure, all exports

PromptsGptClient

HTTP client for the API

Runtime API

runPrompt, runBatch, detectProviders

Sweep API

sweepPrompt, lock management, pre-flight

Orchestration API

parallel, pipeline, eval

Sync API

syncPrompts, writeAgentFiles

Types Reference

All TypeScript type definitions

Guides

In-depth guides for common workflows and concepts.

Execution Modes

Choose between run, batch, sweep, orchestrate

Sweep vs Prompts

Deep comparison of execution approaches

Providers

Install, configure, and compare providers

Agent Integrations

What gets generated for each agent target

CI/CD Integration

GitHub Actions, GitLab CI, automation

Prompt Authoring

Write effective prompts and sweep files

Interactive Mode

Using the CLI interactively

Configuration Reference

---

config.json

Full config schema and properties

Environment Variables

All env vars recognized by the CLI

YAML Frontmatter

Prompt and sweep file frontmatter schema

Exit Codes

CLI exit code reference

Artifacts

Run artifact directory structure

Advanced Topics

---

Self-Evaluation

Automatic scoring of agent output

Orchestration Patterns

Multi-agent workflow patterns

Custom Models

Model registry management

Security

Credential storage, network, git safety

Troubleshooting

Common issues and solutions