Synced package doc
Docs/prompts-gpt Package/prompts-gpt doctor

prompts-gpt doctor

Validate prerequisites, provider installations, and configuration health.

Usage

prompts-gpt doctor [--fix] [--remote] [--json] [--cwd <path>]

What It Checks

- Codex — binary path and version - Claude — binary path and version - Cursor — binary path and version - Copilot — binary path and version

- CI / non-interactive mode detection - PROMPTS_GPT_TOKEN secret injection - API URL safety - Provider auth env presence - Destructive git protection - Artifact directory gitignore coverage - Local credentials leakage risk

  • Node.js version (requires ≥ 18.18)
  • OS platform and architecture
  • CPU count
  • Config file presence and validity
  • Provider CLIs:
  • Remote execution readiness when --remote is set:

Output

prompts-gpt doctor
──────────────────
Node.js:    v22.0.0 ✓
OS:         darwin arm64
CPUs:       10
Config:     .prompts-gpt/config.json ✓

Providers:
  codex     /usr/local/bin/codex     1.0.12  ✓
  claude    /usr/local/bin/claude    1.0.30  ✓
  cursor    /usr/local/bin/cursor    0.46.0  ✓
  copilot   not found                        ✗

JSON Output

prompts-gpt doctor --json

Returns a DoctorResult object:

{
  nodeVersion: string;
  platform: string;
  arch: string;
  cpus: number;
  configFound: boolean;
  notes: string[];
  providers: Array<{
    provider: string;
    available: boolean;
    version: string | null;
    bin: string;
  }>;
  remote?: {
    requested: boolean;
    ciDetected: boolean;
    checks: Array<{
      name: string;
      status: "pass" | "warn" | "fail";
      message: string;
    }>;
    summary: {
      pass: number;
      warn: number;
      fail: number;
    };
  };
}

Remote Readiness

Use this before enabling CI, a remote devcontainer, or any hosted runner:

prompts-gpt doctor --remote
prompts-gpt doctor --remote --json

The remote audit expects secret-based auth and non-interactive execution. It warns when the workspace still relies on .prompts-gpt/.credentials.json or when the run artifacts directory is not ignored by git.

See Also

  • providers — Detailed provider information
  • status — Full workspace readiness