Skip to content

Minimal Example

The simplest possible PromptScript setup for a single project.

Project Structure

my-project/
├── .promptscript/
│   └── project.prs
├── promptscript.yaml
├── .github/
│   └── copilot-instructions.md  # Generated
└── ...

Files

.promptscript/project.prs

@meta {
  id: "my-project"
  syntax: "1.0.0"
}

@identity {
  """
  You are a helpful coding assistant for this project.
  Focus on clean, readable code.
  """
}

@context {
  """
  This is a TypeScript project using modern best practices.
  """
}

@standards {
  code: {
    style: "functional"
    documentation: "JSDoc for public APIs"
  }
}

@shortcuts {
  "/help": "Show what you can help with"
  "/review": "Review code for quality issues"
  "/test": "Write unit tests"
}

promptscript.yaml

input:
  entry: .promptscript/project.prs

targets:
  github:
    enabled: true
    output: .github/copilot-instructions.md

Usage

Initialize

If starting from scratch:

prs init

Compile

Generate the output file:

prs compile

Validate

Check for issues:

prs validate

Generated Output

.github/copilot-instructions.md

# AI Instructions

## Identity

You are a helpful coding assistant for this project.
Focus on clean, readable code.

## Context

This is a TypeScript project using modern best practices.

## Standards

- Code style: functional
- Documentation: JSDoc for public APIs

## Shortcuts

- `/help` - Show what you can help with
- `/review` - Review code for quality issues
- `/test` - Write unit tests

CLAUDE.md

# AI Instructions

## Identity

You are a helpful coding assistant for this project.
Focus on clean, readable code.

## Context

This is a TypeScript project using modern best practices.

## Standards

- Code style: functional
- Documentation: JSDoc for public APIs

## Shortcuts

- `/help` - Show what you can help with
- `/review` - Review code for quality issues
- `/test` - Write unit tests

.cursorrules

# AI Instructions

## Identity

You are a helpful coding assistant for this project.
Focus on clean, readable code.

## Context

This is a TypeScript project using modern best practices.

## Standards

- Code style: functional
- Documentation: JSDoc for public APIs

## Shortcuts

- /help - Show what you can help with
- /review - Review code for quality issues
- /test - Write unit tests

Adding More Targets

To also generate for Claude and Cursor:

# promptscript.yaml
input:
  entry: .promptscript/project.prs

targets:
  github:
    enabled: true
    output: .github/copilot-instructions.md

  claude:
    enabled: true
    output: CLAUDE.md

  cursor:
    enabled: true
    output: .cursorrules

Then:

prs compile

Next Steps