Skip to content

PromptScript API


Interface: CompileOptions

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

Options for the compile command.

Properties

all?

optional all: boolean

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

Compile all configured targets


config?

optional config: string

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

Path to custom config file


cwd?

optional cwd: string

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

Working directory (project root)


dryRun?

optional dryRun: boolean

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

Preview changes without writing files


force?

optional force: boolean

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

Force overwrite existing files without prompts


format?

optional format: string

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

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


output?

optional output: string

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

Output directory


registry?

optional registry: string

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

Registry path or URL (overrides config)


strict?

optional strict: boolean

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

Treat output path conflicts as errors


target?

optional target: string

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

Specific target to compile (github, claude, cursor)


watch?

optional watch: boolean

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

Watch mode for continuous compilation