EdictumCLI Reference
Canonical Edictum CLI surface from edictum-go.
Right page if: you need the real command-line surface for Edictum today. Wrong page if: you only need the Python or TypeScript runtime API -- see the language-specific docs. For Gate workflow behavior, see https://docs.edictum.ai/docs/guides/gate. Gotcha: the canonical CLI ships from edictum-go. The Python package does not ship general-purpose validate/check/diff/test commands.
The canonical Edictum CLI lives in
edictum-go.
Install it with:
go install github.com/edictum-ai/edictum-go/cmd/edictum@latestCore Commands
| Command | Purpose |
|---|---|
edictum version | Print the installed CLI version |
edictum validate <files...> | Validate YAML rulesets against schema |
edictum check <files...> | Evaluate one tool call against rules |
edictum diff <file1> <file2> [file3...] | Compare rulesets |
edictum replay <bundle> | Replay audit events against rules |
edictum test <bundle> | Run rule test cases |
edictum skill scan <path> | Scan a skill directory or SKILL.md for security risks |
Examples
Validate a rules directory:
edictum validate ./rulesDry-run one call:
edictum check ./rules.yaml \
--tool Read \
--args '{"path":"README.md"}'Diff two policy versions:
edictum diff ./rules-v1.yaml ./rules-v2.yamlScan a skill collection:
edictum skill scan ./skills --threshold HIGHedictum skill scan supports:
--json--threshold CRITICAL|HIGH|MEDIUM--structural-only--verbose
Gate Commands
| Command | Purpose |
|---|---|
edictum gate init | Set up Gate config, rules, and optional workflow |
edictum gate install <assistant> | Register a hook with a coding assistant |
edictum gate uninstall <assistant> | Remove a hook |
edictum gate status | Show Gate config, workflow state, and pending events |
edictum gate audit | Show recent local audit events |
edictum gate sync | Flush buffered audit events to the control plane |
edictum gate check | Preflight evaluation path used by hooks |
edictum gate run -- <command> | Execute a tool call through the full Gate runtime |
edictum gate reset --stage <id> | Reset the active workflow session |
Key behavior:
gate checkis the preflight hook path.gate runis the full runtime path and is what enforces workflow gates.gate initexpects a real--rulesfile or directory if you want policy to load immediately.
What This Page Replaces
Older docs described a Python-packaged CLI with commands such as
pip install edictum[cli], edictum validate, edictum test, and a Python
Gate install path. That is stale. Use the Go CLI above for command-line
workflows.
Related
Last updated on