Skip to main content

Command Overview

beacon rules fields prints the endpoint event fields that threat-rule CEL expressions can match on.
Command syntax
beacon rules fields [flags]
Use this command while authoring rules to confirm field paths and value types.

CEL field paths

Threat-rule expressions bind each Beacon event as e. Field paths mirror the event JSON shape, such as:
Field pathExample use
e.event.actionMatch event type, such as command.executed or file.read
e.command.commandMatch executed command text
e.file.pathMatch a file path
e.prompt.textMatch prompt text when retained
e.gen_ai.usage.input_tokensMatch normalized token usage fields

Examples

Print the field list:
List rule fields
beacon rules fields
Render the field reference as markdown:
Render fields as markdown
beacon rules fields --markdown

Flags

FlagDescription
--markdownRender as a markdown reference table

beacon rules lint

Validate CEL expressions and embedded fixtures.

Endpoint Event Schema

Review normalized Beacon endpoint events.