Skip to content

CompileOptions

PromptScript API


Defined in: cli/src/types.ts:58

Options for the compile command.

Properties

all?

optional all?: boolean

Defined in: cli/src/types.ts:68

Compile all configured targets


allBuilds?

optional allBuilds?: boolean

Defined in: cli/src/types.ts:62

Compile all named build profiles in deterministic key order


build?

optional build?: string

Defined in: cli/src/types.ts:60

Named build profile from config.builds


check?

optional check?: boolean

Defined in: cli/src/types.ts:85

Write nothing and exit 1 when generated files are out of date: files to write or change, and stale generated files to remove.


config?

optional config?: string

Defined in: cli/src/types.ts:91

Path to custom config file


cwd?

optional cwd?: string

Defined in: cli/src/types.ts:99

Working directory (project root)


dryRun?

optional dryRun?: boolean

Defined in: cli/src/types.ts:80

Preview changes without writing files


force?

optional force?: boolean

Defined in: cli/src/types.ts:93

Force overwrite existing files without prompts


format?

optional format?: string

Defined in: cli/src/types.ts:66

Output format (github, claude, cursor) - alias for target


ignoreHashes?

optional ignoreHashes?: boolean

Defined in: cli/src/types.ts:97

Skip reference integrity hash verification


migrateFactoryHooks?

optional migrateFactoryHooks?: boolean

Defined in: cli/src/types.ts:87

Migrate unambiguous legacy Factory settings hooks during compilation


output?

optional output?: string

Defined in: cli/src/types.ts:72

Output directory


registry?

optional registry?: string

Defined in: cli/src/types.ts:89

Registry path or URL (overrides config)


resources?

optional resources?: string[]

Defined in: cli/src/types.ts:78

Compile only selected resource kinds (agents, skills, commands, mcp, hooks, plugins, main). Omits unselected resources and, without main, all root instruction files.


strict?

optional strict?: boolean

Defined in: cli/src/types.ts:95

Treat output path conflicts as errors


target?

optional target?: string

Defined in: cli/src/types.ts:64

Specific target to compile (github, claude, cursor)


watch?

optional watch?: boolean

Defined in: cli/src/types.ts:70

Watch mode for continuous compilation