PromptScriptConfig
Defined in: core/src/types/config.ts:443
PromptScript configuration file (promptscript.yaml).
Properties
builds?
optionalbuilds?:Record<string,BuildProfileConfig>
Defined in: core/src/types/config.ts:622
Named per-command build profiles. Profiles let one repository build multiple instruction artifacts to different target directories without changing the default project compile.
customConventions?
optionalcustomConventions?:Record<string,OutputConvention>
Defined in: core/src/types/config.ts:671
Custom convention definitions. Register custom conventions that can be referenced by name in targets.
description?
optionaldescription?:string
Defined in: core/src/types/config.ts:451
Project description
eval?
optionaleval?:EvalConfig
Defined in: core/src/types/config.ts:697
Eval settings: providers and run limits.
Example
eval: providers: anthropic: { kind: anthropic, apiKeyEnvVar: ANTHROPIC_API_KEY }extends?
optionalextends?:string
Defined in: core/src/types/config.ts:461
Extend another configuration file. Paths are resolved relative to the current config file.
Example
extends: '../base-config.yaml'formatting?
optionalformatting?:FormattingConfig
Defined in: core/src/types/config.ts:649
Formatting configuration. Controls how generated markdown files are formatted.
Example
formatting: prettier: true # Auto-detect .prettierrc
formatting: tabWidth: 4 proseWrap: alwaysgovernance?
optionalgovernance?:GovernanceConfig
Defined in: core/src/types/config.ts:706
Governance settings: admins and approval roles.
Example
governance: admins: ['@acme/prompt-platform'] roles: { legal: ['@acme/legal'] }id
id:
string
Defined in: core/src/types/config.ts:445
Project identifier
includePromptScriptSkill?
optionalincludePromptScriptSkill?:boolean
Defined in: core/src/types/config.ts:730
Include the bundled PromptScript language skill in compilation output. When enabled, the SKILL.md that teaches AI agents how to work with .prs files is automatically added to each target’s native skill directory.
Default
trueinherit?
optionalinherit?:string
Defined in: core/src/types/config.ts:464
Inheritance path
input?
optionalinput?:object
Defined in: core/src/types/config.ts:470
Input file configuration. Controls which PromptScript files to compile.
entry?
optionalentry?:string
Entry file path (defaults to ‘.promptscript/project.prs’)
exclude?
optionalexclude?:string[]
Glob patterns for files to exclude
include?
optionalinclude?:string[]
Glob patterns for additional files to include
models?
optionalmodels?:ModelsConfig
Defined in: core/src/types/config.ts:680
Model catalog settings: the model set the instructions are written for and custom model profiles.
Example
models: supported: [claude-opus-5-5, gpt-6-sol]output?
optionaloutput?:object
Defined in: core/src/types/config.ts:582
Output configuration. Global output settings applied to all targets.
baseDir?
optionalbaseDir?:string
Base directory for all output files
header?
optionalheader?:string
Custom header to prepend to generated files
manifest?
optionalmanifest?:boolean
Write a manifest of generated files (.promptscript-generated.json) in
the output directory. The next compile removes files that are listed in
the old manifest but no longer generated, when they were not edited
since. prs compile --check also reports them. Always on when
markers is none.
Default
falsemarkers?
optionalmarkers?:"none"|"timestamp"|"static"
How generated files are marked.
timestamp(default): marker with the generation time. A setSOURCE_DATE_EPOCHreplaces the clock.static: marker without a time, so the output is reproducible.none: no marker. Ownership of generated files comes from the generated files manifest, which is then always written. Skill resource files never get a marker.
Default
'timestamp'overwrite?
optionaloverwrite?:boolean
Whether to overwrite existing files without warning
resources?
optionalresources?:OutputResourceKind[]
Compile only selected resource kinds (agents, skills, commands, mcp, hooks, plugins, main). A global install can emit agent and skill directories without unrelated root instruction files.
policies?
optionalpolicies?:PolicyDefinition[]
Defined in: core/src/types/config.ts:771
Policies for skill extensions and prompts
registries?
optionalregistries?:RegistriesConfig
Defined in: core/src/types/config.ts:561
Named registry aliases for multi-source imports.
Maps alias names to Git repository URLs.
Coexists with registry - aliases take precedence for matching paths.
registry?
optionalregistry?:object
Defined in: core/src/types/config.ts:480
Registry configuration
auth?
optionalauth?:object
Authentication for HTTP registries
auth.token?
optionaltoken?:string
Token for bearer auth, or “username:password” for basic auth
auth.tokenEnvVar?
optionaltokenEnvVar?:string
Environment variable containing the token (alternative to token)
auth.type
type:
"bearer"|"basic"
Authentication type
cache?
optionalcache?:object
Cache settings
cache.enabled?
optionalenabled?:boolean
Whether caching is enabled
cache.ttl?
optionalttl?:number
Cache TTL in milliseconds
git?
optionalgit?:object
Git repository configuration. When specified, the registry will be cloned from a Git repository.
git.auth?
optionalauth?:object
Authentication options for private repositories
git.auth.sshKeyPath?
optionalsshKeyPath?:string
Path to SSH key (for SSH auth).
Default
'~/.ssh/id_rsa'git.auth.token?
optionaltoken?:string
Personal access token (for token auth)
git.auth.tokenEnvVar?
optionaltokenEnvVar?:string
Environment variable containing the token
git.auth.type
type:
"token"|"ssh"
Authentication type.
- ‘token’: Use a personal access token (PAT)
- ‘ssh’: Use SSH key authentication
git.fallbackUrl?
optionalfallbackUrl?:string
Fallback Git URL to try when the primary url fails with an auth error.
Useful when the registry references an HTTPS URL but the user authenticates
via SSH (or vice versa).
Example
registry: git: url: 'https://github.com/org/registry.git'git.path?
optionalpath?:string
Subdirectory within the repository to use as registry root.
Example
'registry/'git.ref?
optionalref?:string
Git ref to checkout (branch, tag, or commit hash).
Default
'main'git.timeout?
optionaltimeout?:number
Maximum wall-clock time in milliseconds for each Git operation. Defaults to 60000; can also be raised globally via PROMPTSCRIPT_GIT_TIMEOUT.
git.url
url:
string
Git repository URL (HTTPS or SSH)
path?
optionalpath?:string
Local path to registry
url?
optionalurl?:string
Remote URL (HTTP registry)
releases?
optionalreleases?:ReleasesConfig
Defined in: core/src/types/config.ts:688
Release settings for prompt bundles.
Example
releases: environments: [staging, prod]skillTargets?
optionalskillTargets?:Record<string,string>
Defined in: core/src/types/config.ts:636
Per-source output directories for @use imports.
Maps a @use source string (matching the path’s raw value) to a
relative directory underneath each target’s skill output location.
An inline into "<path>" on the same @use declaration overrides
the configured value.
Example
skillTargets: "github.com/coreyhaines31/marketingskills/skills/seo-audit": "skills/seo-audit"syntax
syntax:
string
Defined in: core/src/types/config.ts:448
PromptScript syntax version
targets?
optionaltargets?:TargetEntry[]
Defined in: core/src/types/config.ts:665
Output targets.
Optional only when every target lives in a named build profile: such
builds-only projects compile through --build <name> or --all-builds.
Can be simple names or objects with configuration:
Example
targets: - github - claude: convention: markdown output: custom/CLAUDE.mdtelemetry?
optionaltelemetry?:boolean
Defined in: core/src/types/config.ts:454
Enable anonymous aggregate usage telemetry for this project
universalDir?
optionaluniversalDir?:string|boolean
Defined in: core/src/types/config.ts:722
Universal directory for auto-discovering skills and commands.
Skills are discovered from <universalDir>/skills/ and commands from <universalDir>/commands/.
trueor omitted: Use default.agents/directoryfalse: Disable universal directory discoverystring: Custom path (relative to project root)
Default
'.agents'Example
universalDir: true # Use .agents/ (default)universalDir: '.my-agents' # Custom directoryuniversalDir: false # Disablevalidation?
optionalvalidation?:object
Defined in: core/src/types/config.ts:733
Validation settings
allowedPatterns?
optionalallowedPatterns?:string[]
Pattern sources exempt from blocked-patterns detection. A pattern is subtracted from the active set when its source text matches an entry exactly. Mirror of blockedPatterns for exceptions.
Example
allowedPatterns: - 'bypass\s+(your\s+)?(rules|restrictions)'excludes?
optionalexcludes?:ValidationExclude[]
Rule exclusions for specific imports, bound to the pinned commit.
Example
excludes: - import: github.com/cloudflare/skills commit: 1a2b3c4d5e6f... rules: [blocked-patterns, authority-injection]guardRequiresDepth?
optionalguardRequiresDepth?:number
Maximum depth for recursive guard requires resolution. Default: 3. Must be >= 1. Values <= 0 are clamped to 1 by the resolver.
requiredGuards?
optionalrequiredGuards?:string[]
rules?
optionalrules?:Record<string,"error"|"warning"|"off">
scanExternalContent?
optionalscanExternalContent?:boolean
Scan imported (registry cache / vendored) content with heuristic validation rules. Heuristic rules skip imported content by default because a project cannot fix findings in someone else’s skill. Concrete security findings (decoded payloads, suspicious URLs) always scan imported content.
Default
falsewatch?
optionalwatch?:object
Defined in: core/src/types/config.ts:567
Watch mode configuration.
Settings for prs compile --watch.
clearScreen?
optionalclearScreen?:boolean
Clear screen before each recompilation
debounce?
optionaldebounce?:number
Debounce time in milliseconds before recompiling
exclude?
optionalexclude?:string[]
Glob patterns for files to ignore
include?
optionalinclude?:string[]
Glob patterns for files to watch (defaults to ’**/*.prs’)