Examples¶
Real-world PromptScript configuration examples.
Minimal
The simplest possible PromptScript configuration — just the essentials.
→
Team Setup
Multi-project setup with shared team configuration and standards.
→
Enterprise
Full enterprise deployment with governance, private registries, and compliance.
→
Skills & Local
Advanced AI skills and private local memory for specialized workflows.
→
Claude Agents
Define specialized AI subagents for Claude Code with custom tools and models.
→
Git Registry
Use Git repositories as shared registries with version control and authentication.
→
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: [
"Use functional components with hooks",
"React Query for server state, Zustand for client",
"Use Tailwind utility classes for styling"
]
}
@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: [
"Use URL path versioning",
"Document with OpenAPI 3.0",
"Use JWT for authentication"
]
database: [
"Use migrations for schema changes",
"Use 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 (Local Registry)¶
# 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: .cursor/rules/project.mdc
validation:
strict: true
watch:
debounce: 300