Skip to content

PromptScript API


Interface: CompileOptions

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

Options for the compile command.

Properties

all?

optional all?: boolean

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

Compile all configured targets


build?

optional build?: string

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

Named build profile from config.builds


config?

optional config?: string

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

Path to custom config file


cwd?

optional cwd?: string

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

Working directory (project root)


dryRun?

optional dryRun?: boolean

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

Preview changes without writing files


force?

optional force?: boolean

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

Force overwrite existing files without prompts


format?

optional format?: string

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

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


ignoreHashes?

optional ignoreHashes?: boolean

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

Skip reference integrity hash verification


output?

optional output?: string

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

Output directory


registry?

optional registry?: string

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

Registry path or URL (overrides config)


strict?

optional strict?: boolean

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

Treat output path conflicts as errors


target?

optional target?: string

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

Specific target to compile (github, claude, cursor)


watch?

optional watch?: boolean

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

Watch mode for continuous compilation