Reference
Crismo CLI
Scriptable access to your process models for automation and CI. The CLI wraps the REST API and covers diagrams, value chains, dictionaries, attributes, sharing, and milestones.
Install
Install the CLI globally, or run it on demand with npx.
terminal
npm install -g @crismo/cli
# or, without installing:
npx @crismo/cli <command>Authentication
Store your API key once (Enterprise plan). You can switch environments and inspect status at any time.
terminal
crismo auth set-key crismo_XXXX_your_api_key
crismo auth status
crismo auth set-env <staging|production>Add --json to any command for machine-readable output.
Global flags
--json | Machine-readable JSON output (for scripts and CI). |
--env <staging|production> | Target environment for this command. |
--help | Show usage for any command. |
Diagrams
crismo list | List all diagrams in the workspace. |
crismo get <id> [--dsl] [--json] | Get a diagram as XML, DSL, or JSON. |
crismo create [--author <name>] | Create a diagram (reads BPMN XML from stdin). |
crismo patch <id> [--author <name>] | Apply a JSON patch to a diagram. |
crismo delete <id> | Delete a diagram. |
example
# create a diagram from a BPMN file, then read it back
cat order.bpmn | crismo create --author "CI" --json
crismo get <id> --dslProcess links
crismo links <id> | List process links for a diagram. |
crismo link <id> --element <el> --target <tgt> | Link an element to another diagram. |
crismo unlink <id> --element <el> --target <tgt> | Remove a process link. |
Value chains
crismo vc list | List value chains. |
crismo vc get <id> | Get a value chain with its segments. |
crismo vc create --name <n> [--type core|support] [--template <id>] | Create a value chain. |
crismo vc update <id> [--name <n>] | Update a value chain. |
crismo vc delete <id> | Delete a value chain. |
crismo vc duplicate <id> | Duplicate a value chain. |
crismo vc templates | List available templates. |
crismo vc segments <vcId> | List segments. |
crismo vc add-segment <vcId> --name <n> | Add a segment. |
crismo vc delete-segment <vcId> <segId> | Delete a segment. |
crismo vc link-diagram <vcId> <segId> --diagram <id> | Link a diagram to a segment. |
crismo vc unlink-diagram <vcId> <segId> --diagram <id> | Unlink a diagram from a segment. |
crismo vc context <diagramId> | Show the value chain context for a diagram. |
example
crismo vc create --name "Order to Cash" --type core --json
crismo vc add-segment <vcId> --name "Fulfilment" --level L1
crismo vc link-diagram <vcId> <segId> --diagram <id>Dictionaries
crismo dict list | List dictionaries. |
crismo dict get <id> | Get a dictionary with entries. |
crismo dict create --name <n> | Create a dictionary. |
crismo dict delete <id> | Delete a dictionary. |
crismo dict entries <dictId> | List entries. |
crismo dict add-entry <dictId> --name <n> | Add an entry. |
crismo dict delete-entry <dictId> <entryId> | Delete an entry. |
crismo dict search <dictId> --prefix <p> | Search entries by prefix. |
crismo dict link <diagramId> <elementId> --dict <dictId> --entry <entryId> | Link an element to an entry. |
crismo dict unlink <diagramId> <elementId> --dict <dictId> --entry <entryId> | Unlink an element from an entry. |
crismo dict usages <dictId> <entryId> | Show where an entry is used. |
example
crismo dict create --name "Glossary" --json
crismo dict add-entry <dictId> --name "SLA"
crismo dict search <dictId> --prefix "inv" --jsonAttributes
crismo attr list | List attribute definitions. |
crismo attr create --name <n> [--type ...] [--scope ...] | Create an attribute definition. |
crismo attr delete <id> | Delete an attribute definition. |
crismo attr get <diagramId> <elementId> | Get attribute values for an element. |
crismo attr set <diagramId> <elementId> --attr <id> --value <v> | Set a value on an element. |
crismo attr unset <diagramId> <elementId> --attr <id> | Remove a value from an element. |
crismo attr get-entry <dictId> <entryId> | Get attributes for a dictionary entry. |
crismo attr set-entry <dictId> <entryId> --attr <id> --value <v> | Set a value on a dictionary entry. |
crismo attr unset-entry <dictId> <entryId> --attr <id> | Remove a value from a dictionary entry. |
Sharing
crismo share create <diagramId> | Create a share link. |
crismo share list <diagramId> | List share links. |
crismo share get <shareId> | Get share link details. |
crismo share deactivate <shareId> | Deactivate a share link. |
crismo share delete <shareId> | Delete a share link. |
Milestones
crismo milestone list <diagramId> | List milestones. |
crismo milestone create <diagramId> [--label <l>] | Create a checkpoint. |
crismo milestone get <diagramId> <milestoneId> [--xml] | Get a milestone (optionally its XML). |
crismo milestone restore <diagramId> <milestoneId> | Restore a diagram to a milestone. |
crismo milestone compare <diagramId> <fromId> <toId> | Compare two milestones. |
crismo milestone delete <diagramId> <milestoneId> | Delete a milestone. |
example
crismo milestone create <id> --label "before refactor"
crismo milestone compare <id> <fromId> <toId> --json
crismo milestone restore <id> <milestoneId>Prefer natural language? The MCP server exposes the same operations to AI assistants.
Script your process models
Automate modeling, migration, and governance from the command line or CI.