Skip to main content

FileRule

@a16njs/models

@a16njs/models / FileRule

Interface: FileRule

Defined in: types.ts:110

A rule that is triggered by file patterns. Examples: Cursor rules with globs

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: FileRule

Defined in: types.ts:111

The type of customization

Overrides​

AgentCustomization.type

globs​

globs: string[]

Defined in: types.ts:113

File patterns that trigger this rule