Skip to main content

Module commands

Module commands 

Source
Expand description

The command contract: one table describing every siderite command.

Dispatch, help text and siderite commands --json all read COMMANDS, so what a command needs (a package, the compiled app), what it may change (project files, the database, build output), whether it touches live services and which output formats it offers are declared once. The JSON list is versioned for AI clients.

Structs§

Command
One command.
CommandList
The data of the commands envelope.

Enums§

Format
An output format a command offers.
Group
Help section of a command.
Live
Whether a command connects to live services.
Mutation
What a command may change.
Needs
What a command needs to find.
Runner
Where a command runs.

Constants§

COMMANDS
Every command, in help order.
COMMANDS_VERSION
Version of the commands report, bumped for breaking changes.

Functions§

find
The command for word (the first word, as typed).
help
Help lines for the commands filter keeps, grouped and aligned.
list
The command list for siderite commands --json.
resolve
The command named by the positional words of args (ai init before ai), ignoring flags and the values of global flags.
table
The text form of siderite commands: what each command needs, may change and touches.