Skip to main content

GlobalPrompt

@a16njs/models

@a16njs/models / GlobalPrompt

Interface: GlobalPrompt

Defined in: types.ts:50

A global prompt that is always applied. Examples: CLAUDE.md, Cursor rules with alwaysApply: true

Extends​

Properties​

id​

id: string

Defined in: types.ts:31

Unique identifier for this item

Inherited from​

AgentCustomization.id

version​

version: string

Defined in: types.ts:35

IR version (required, e.g., 'v1beta1')

Inherited from​

AgentCustomization.version

sourcePath?​

optional sourcePath: string

Defined in: types.ts:37

Original file path where this was discovered (optional, omitted in IR format)

Inherited from​

AgentCustomization.sourcePath

relativeDir?​

optional relativeDir: string

Defined in: types.ts:39

Relative directory path for preserving directory structure (optional)

Inherited from​

AgentCustomization.relativeDir

content​

content: string

Defined in: types.ts:41

The actual prompt/rule content

Inherited from​

AgentCustomization.content

metadata​

metadata: Record<string, unknown>

Defined in: types.ts:43

Tool-specific extras that don't fit the standard model (transient, not serialized in IR)

Inherited from​

AgentCustomization.metadata

type​

type: GlobalPrompt

Defined in: types.ts:51

The type of customization

Overrides​

AgentCustomization.type

name​

name: string

Defined in: types.ts:57

Canonical name for emission output filename (e.g. 'cursorrules', 'CLAUDE'). Set at discovery time using inferGlobalPromptName(sourcePath) from @a16njs/models. Emission plugins use this directly — no re-derivation from source paths needed.