@promptscript/cli

One source of truth for all your AI coding assistants.

Write AI instructions once in PromptScript, compile to 37 AI coding agents: GitHub Copilot, Claude Code, Cursor, and more.

The Problem

• ❌ 50 repos × 37 AI tools = 1,900 files to keep in sync
• ❌ Security policy update? Manual changes across every repo
• ❌ Switching AI tools? Rewrite everything
• ❌ No audit trail, no inheritance, no validation

The Fix

PromptScript lets you build prompts like code - with inheritance, composition, parameterization, and compilation to any target format.

• ✅ Write once in .prs, compile to all 37 agents
• ✅ Update the source, propagates everywhere automatically
• ✅ Hierarchical inheritance like code, not copy-paste
• ✅ Full validation, audit trail, and version pinning

Quick Start

# Install
npm install -g @promptscript/cli

# Initialize (auto-detects your tech stack)
prs init

# Compile to all configured AI tools
prs compile

Already have CLAUDE.md or .cursorrules?

# Import existing AI instruction file to PromptScript
prs import CLAUDE.md

# Preview the conversion without writing files
prs import .cursorrules --dry-run

# Auto-detect and migrate during project init
prs init --migrate

Example

.promptscript/project.prs:

@meta { id: "checkout-service" syntax: "1.0.0" }

@inherit @company/backend-security
@use @fragments/testing
@use @fragments/typescript-strict

@identity {
  """
  You are an expert Backend Engineer working on the Checkout Service.
  This service handles payments using hexagonal architecture.
  """
}

@shortcuts {
  "/review": "Security-focused code review"
  "/test": "Write unit tests with Vitest"
}

@skills {
  deploy: {
    description: "Deploy service to production"
    userInvocable: true
    allowedTools: ["Bash", "Read"]
  }
}

Run prs compile and get correctly formatted output for every AI tool your team uses.

Commands

Key Features

• Inheritance - build org-wide, team-level, and project-level configs that cascade like CSS
• Composition - reuse fragments across projects with @use
• Parameterized templates - @inherit @stacks/node(port: 8080, db: "postgres")
• Skills - define reusable AI skills with SKILL.md files, resource bundles, and tool permissions
• Multi-target compilation - one source, any number of AI tools
• Watch mode - instant recompilation on file changes
• Overwrite protection - never accidentally clobbers hand-written files
• Validation - catch errors before they reach your AI tools
• Registry support - share configs via Git registries (private or public)
• AI-assisted migration - convert existing CLAUDE.md, .cursorrules, etc.
• Bundled language skill - AI agents learn PromptScript syntax via injected SKILL.md

Supported Targets

Plus 30 more agents (Windsurf, Cline, Roo Code, Codex, Continue, Augment, and others). See the full list.

Configuration

promptscript.yaml:

version: '1'

input:
  entry: '.promptscript/project.prs'

targets:
  - github
  - claude
  - cursor
  - factory
  - opencode
  - gemini

See the full configuration reference for registry auth, watch settings, validation rules, and more.

Detailed Command Usage

Init

prs init [options]

Options:
  -n, --name <name>        Project name (auto-detected)
  -t, --team <team>        Team namespace
  --inherit <path>         Inheritance path (e.g., @company/team)
  --registry <path>        Registry path
  --targets <targets...>   Target AI tools (github, claude, cursor, opencode, gemini, ...)
  -i, --interactive        Force interactive mode
  -y, --yes                Skip prompts, use defaults
  -f, --force              Force reinitialize even if already initialized

Auto-detection: Project name, languages, frameworks, and existing AI tool configurations.

Creates:

• promptscript.yaml - Configuration file
• .promptscript/project.prs - Main project file

Compile

prs compile [options]

Options:
  -t, --target <target>   Specific target (github, claude, cursor, opencode, gemini, ...)
  -a, --all               All configured targets (default)
  -w, --watch             Watch mode for continuous compilation (uses chokidar)
  -o, --output <dir>      Output directory
  --dry-run               Preview changes without writing files
  --force                 Force overwrite existing files without prompts
  --registry <path>       Path or URL to registry
  -c, --config <path>     Path to custom config file
  --cwd <dir>             Working directory (project root)
  --verbose               Show detailed compilation progress
  --debug                 Show debug information (includes verbose)

Watch Mode: Uses chokidar for reliable file watching across all platforms. Automatically recompiles when .prs files change.

Overwrite Protection: By default, prs compile protects user-created files from accidental overwriting. Files generated by PromptScript contain a marker (> Auto-generated by PromptScript) and are overwritten silently. For files without this marker:

• Interactive mode: You'll be prompted to overwrite (y/N/a)
• Non-interactive mode: Compilation fails with a list of conflicting files

Use --force to skip all prompts and overwrite everything. Use --dry-run to preview conflicts before writing.

Import

prs import <file> [options]

Options:
  -f, --format <format>   Source format (claude, github, cursor, generic)
  -o, --output <dir>      Output directory (default: .promptscript)
  --dry-run               Preview output without writing files
  --validate              Run roundtrip validation after import

Imports existing AI instruction files (CLAUDE.md, .cursorrules, copilot-instructions.md) into PromptScript format. Uses heuristic classification to map sections to appropriate @identity, @standards, @restrictions, and @knowledge blocks with confidence scoring.

Validate

prs validate [options]

Options:
  --strict                Treat warnings as errors
  --format <format>       Output format (text, json)

Pull Updates

prs pull [options]

Options:
  -f, --force             Force overwrite local files

Show Diff

prs diff [options]

Options:
  -t, --target <target>   Specific target to diff
  --full                  Show full diff without truncation
  --no-pager              Disable pager output

By default, diff output is shown through a pager (less) for easy scrolling. Use --no-pager to disable this behavior. You can customize the pager via the PAGER environment variable.

Check for Updates

prs update-check

Checks if a newer version of the CLI is available on npm and displays the result:

@promptscript/cli v1.0.0
✓ Up to date

Or if an update is available:

@promptscript/cli v1.0.0
Update available: 1.0.0 → 1.1.0 (npm i -g @promptscript/cli)

Automatic Update Checks: The CLI automatically checks for updates once every 24 hours when running any command. The check is non-blocking and cached locally. To disable automatic checks, set the PROMPTSCRIPT_NO_UPDATE_CHECK environment variable:

PROMPTSCRIPT_NO_UPDATE_CHECK=1 prs compile

Environment Variables

Docker

No Node.js? Use the Docker image:

docker run --rm -v $(pwd):/workspace ghcr.io/mrwogu/promptscript:latest compile
docker run --rm -v $(pwd):/workspace ghcr.io/mrwogu/promptscript:latest validate --strict

Documentation

• Getting Started - 5-minute quickstart
• Language Reference - full syntax docs
• Guides - inheritance, registry, migration, and more
• Enterprise - scaling across organizations

License

MIT