Command-line interface
Invokeable CLI
Use the same workspaces, permissions, Catalog, journeys, runs, findings, and account controls from a terminal.
The Invokeable CLI is a complete customer interface. It reads and writes the same workspace records as the web application and follows the same permission checks.
Use ivk for interactive work and invokeable when a descriptive command is clearer in scripts. Both names run the same program.
ivk --help
ivk status
ivk catalog list
ivk journeys list
ivk runs list
ivk findings listWhat the CLI covers
- Account setup, sign-in, sign-out, and workspace switching
- Workspace readiness
- Product connections and the action Catalog
- Connected agents and compatibility
- Journey creation, approval, coverage, and baselines
- Assessment planning, execution, progress, cancellation, and stopping
- Test results, evidence exports, findings, fixes, and verification
- Safety rules, the workspace kill switch, quarantines, and side effects
- Notifications, members, profile, workspace, billing, and data controls
- Roles, approvals, support cases, and the product changelog
Start here
Install
Install the CLI and confirm the executable.
Sign in
Authorize the CLI and choose a workspace.
First assessment
Connect, create a journey, run it, and inspect the result.
Command reference
Browse command groups and aliases.
Global options
| Option | Purpose |
|---|---|
--json | Print one machine-readable JSON document |
--no-color | Disable terminal colors |
--profile production | Use the default production configuration |
--profile staging | Use an isolated staging configuration |
--endpoint <url> | Override the configured Invokeable endpoint |
--client-id <id> | Override the configured sign-in client ID |
--version | Print the installed version |
Production and staging keep separate configuration and credentials. Do not use the staging profile for ordinary customer automation.