Examples¶
Real-world PromptScript configuration examples.
Quick Examples¶
Basic Project¶
@meta {
id: "my-project"
syntax: "1.0.0"
}
@identity {
"""
You are a helpful coding assistant.
"""
}
@shortcuts {
"/help": "Show available commands"
}
React Project¶
@meta {
id: "react-app"
syntax: "1.0.0"
}
@identity {
"""
You are a React expert specializing in modern TypeScript applications.
"""
}
@context {
framework: "React 18"
language: "TypeScript"
styling: "TailwindCSS"
testing: "Vitest + Testing Library"
}
@standards {
code: {
components: "functional with hooks"
state: "React Query + Zustand"
styling: "Tailwind utility classes"
}
}
@shortcuts {
"/component": "Create a new React component"
"/hook": "Create a custom hook"
"/test": "Write component tests"
}
API Service¶
@meta {
id: "api-service"
syntax: "1.0.0"
}
@identity {
"""
You are a backend expert building RESTful APIs with Node.js.
"""
}
@context {
runtime: "Node.js 20"
framework: "Express"
database: "PostgreSQL"
orm: "Prisma"
}
@standards {
api: {
versioning: "URL path"
documentation: "OpenAPI 3.0"
authentication: "JWT"
}
database: {
migrations: required
transactions: "for multi-step operations"
}
}
@restrictions {
- "Never expose internal errors to clients"
- "Always validate request body"
- "Never store plain-text passwords"
}
@shortcuts {
"/endpoint": "Design a new API endpoint"
"/migration": "Create a database migration"
"/test": "Write API tests"
}
Configuration Examples¶
Basic Config¶
Full Config¶
# promptscript.yaml
input:
entry: .promptscript/project.prs
include:
- '.promptscript/**/*.prs'
registry:
path: ./registry
targets:
github:
enabled: true
output: .github/copilot-instructions.md
claude:
enabled: true
output: CLAUDE.md
cursor:
enabled: true
output: .cursorrules
validation:
strict: true
watch:
debounce: 300
Browse All Examples¶
- Minimal - Single file, basic setup
- Team Setup - Shared configuration across projects
- Enterprise - Organization-wide deployment
- Skills & Local - Advanced AI skills and private instructions