Skip to content

PromptScript API


Interface: TargetConfig

Defined in: core/src/types/config.ts:71

Configuration for a single target.

Properties

agentsFile?

optional agentsFile?: string

Defined in: core/src/types/config.ts:148

Codex: override the agents file name for scoped build profiles. Defaults to AGENTS.md. Use AGENTS.override.md only for scoped builds.


agentsFrontmatter?

optional agentsFrontmatter?: "experimental"

Defined in: core/src/types/config.ts:158

AGENTS.md v1.1 frontmatter mode. - experimental: emit YAML frontmatter with description and tags from

Meta

  • omitted: no frontmatter (default, byte-compatible with existing output)

Only valid for targets whose fixture accepts frontmatter.

Default

undefined (no frontmatter)

autoMode?

optional autoMode?: "acceptEdits" | "plan" | "bypassPermissions"

Defined in: core/src/types/config.ts:165

Claude: auto mode setting for project settings.json. Maps to .claude/settings.json autoMode field. Only valid for Claude target with fixture-confirmed project-local schema.


convention?

optional convention?: string

Defined in: core/src/types/config.ts:86

Output convention ('xml', 'markdown', or custom name).


enabled?

optional enabled?: boolean

Defined in: core/src/types/config.ts:76

Whether this target is enabled.

Default

true

guardsAsSkills?

optional guardsAsSkills?: boolean

Defined in: core/src/types/config.ts:103

Generate skills from

Guards

named entries (Factory).

Default

true

guardsSkillsListing?

optional guardsSkillsListing?: boolean

Defined in: core/src/types/config.ts:106

List generated guard skills in main output file (Factory).

Default

true

includeSkills?

optional includeSkills?: boolean | string[]

Defined in: core/src/types/config.ts:121

Controls which skills are emitted for this target. - true or omitted: emit all skills - false: emit no skills - string array: emit only the listed skill names


maxDepth?

optional maxDepth?: number

Defined in: core/src/types/config.ts:142

Codex: maximum nesting depth for agent delegation. Positive integer. Maps to Codex config, never to AGENTS.md.


maxThreads?

optional maxThreads?: number

Defined in: core/src/types/config.ts:136

Codex: maximum number of parallel agent threads. Positive integer. Maps to Codex config, never to AGENTS.md.


output?

optional output?: string

Defined in: core/src/types/config.ts:81

Custom output path for this target.


rulesMode?

optional rulesMode?: FactoryRulesMode

Defined in: core/src/types/config.ts:100

Factory always-on rules output mode. Split mode requires Factory's multifile or full version.

Default

'monolith'

skillBaseDir?

optional skillBaseDir?: string

Defined in: core/src/types/config.ts:113

Custom base directory for generated skill files. When set, skill files are emitted under this directory instead of the target's native skill directory (for example .factory/skills).


skillPath?

optional skillPath?: "agents" | "gemini" | "both"

Defined in: core/src/types/config.ts:130

Gemini skill path selection. - agents: use .agents/skills/ (interoperable, fixture-confirmed default) - gemini: use .gemini/skills/ (legacy) - both: emit to both paths (requires explicit opt-in, deduplicates content)

Default

'agents'

version?

optional version?: string

Defined in: core/src/types/config.ts:93

Target version or format variant. Use 'legacy' for deprecated formats (e.g., Cursor's .cursorrules).

Example

'legacy' | '1.0' | '2.0'