Skip to content

PromptScript API


Interface: CompileOptions

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

Options for the compile command.

Properties

all?

optional all: boolean

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

Compile all configured targets


config?

optional config: string

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

Path to custom config file


dryRun?

optional dryRun: boolean

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

Preview changes without writing files


force?

optional force: boolean

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

Force overwrite existing files without prompts


format?

optional format: string

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

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


output?

optional output: string

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

Output directory


registry?

optional registry: string

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

Registry path or URL (overrides config)


target?

optional target: string

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

Specific target to compile (github, claude, cursor)


watch?

optional watch: boolean

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

Watch mode for continuous compilation