Terminal
Terminal/Skill
Command guide for the rsigma CLI and MCP server, covering linting, evaluating, converting, tuning and backtesting Sigma detection rules.
By Tiger Data
Works with
npx skills add timescale/rsigma --skill rsigmaUse rsigma to run Sigma rules. Author the YAML with the sigma-rules skill (npx skills add timescale/sigma-rules -g -y). This skill covers the toolchain: command names, when to call MCP versus the CLI, and which command fits the job.
Flag tables and option lists live at rsigma.io. Read them when you need a flag. Do not invent flags, and do not quote lint or auto-fix counts. The linting guide is the catalogue.
The CLI is noun-led. These old top-level forms do not exist:
| Do not run | Run instead |
|---|---|
rsigma eval | rsigma engine eval |
rsigma lint | rsigma rule lint |
rsigma validate | rsigma rule validate |
rsigma daemon | rsigma engine daemon |
Groups:
| Group | Use it for |
|---|---|
engine | Evaluate events, explain a miss, classify schemas, and run or inspect the daemon (eval, explain, classify, discover-schemas, status, tap, tail, daemon) |
rule | Lint, validate, draft, tune, test exemplars, backtest, and reverse-convert |
backend | Convert rules to a query (convert, targets, formats) |
pipeline | See how a pipeline rewrites a rule (diff) and dry-run dynamic sources (resolve) |
mcp | Serve the toolchain to an agent (serve) |
config | Scaffold and inspect rsigma.yaml |
engine daemon and pipeline resolve need a build with the daemon feature. mcp serve needs the mcp feature. Release binaries and the Docker image include both. rsigma --features prints what this binary was built with.
Full tree: CLI reference.
If rsigma mcp serve is already connected, call its tools. They return JSON (ok, findings, matches) and you do not scrape CLI text. If it is not connected, use the CLI commands in workflows.md.
Start a local server only when the user wants the agent wired up:
rsigma mcp serve --rules-dir rules/
Point --daemon-url at a running daemon when the task is live triage (incidents, silences, dispositions). Those tools stay off until that URL is set. Writes stay behind --allow-operate-writes. Details: MCP server guide.
engine eval. A long-running process with reload, metrics, and sinks: engine daemon.--groups for a temporal correlation): rule draft. A rule the user already described in words: write the YAML with sigma-rules, then lint and evaluate it here.rule tune.rsigma.exemplars: rule test. A separate corpus and expectations file: rule backtest.engine explain. How a pipeline rewrote fields: pipeline diff.The write-lint-evaluate-convert loop, with the MCP tool beside each CLI command, is in workflows.md.
Native targets run inside rsigma. Anything else is delegated to an installed sigma-cli.
rsigma backend targets
rsigma backend convert -t postgres rules/
rsigma backend convert -t splunk rules/
Native targets are postgres (postgresql, pg), lynxdb, and fibratus, plus a backend-neutral test target that is not a deployment backend. backend targets is the live list. Delegated conversion needs sigma on PATH (override with RSIGMA_SIGMA_CLI). The Docker image has no Python, so delegation is a local-binary feature. On MCP, convert_rules delegates only when the server was started with --allow-sigma-cli. Builtin pipeline names (ecs_windows, fibratus_windows, sysmon) are not translated for delegated targets. Pass a sigma-cli pipeline name or a YAML path.
See backend convert and sigma-cli delegation.