Trickest CLI
Drive the entire Trickest platform from your terminal — spaces, workflows, runs, data, and the AI agent — with a machine-first, scriptable interface.
On this page7
The trickest CLI is a single binary that exposes the whole Trickest platform:
spaces and workflows, runs and outputs, the Live Table database, file storage and
variables, the tool/module library, fleets, users, and the AI agent's memory,
sessions, and skills.
It is built machine-first. Output is JSON by default, every error is a structured envelope with a meaningful exit code, and the CLI remembers your active context so you don't repeat IDs. That makes it equally good for a human at a prompt and for an AI agent or CI pipeline driving the platform programmatically.
Install
The CLI ships as a standalone binary. Install it with one command — the
installer detects your OS and architecture and drops the binary on your PATH:
curl -fsSL https://trickest.io/install.sh | shPrefer to grab a binary yourself? Every release is published with checksums; pick your platform from the API & CLI settings page in the app.
Verify the install:
trickest --version
# 1.0.0Authenticate
The fastest way to authenticate — ideal for agents and CI — is the
TRICKEST_TOKEN environment variable:
export TRICKEST_TOKEN=<your-api-token>
trickest auth status
# {"authenticated":true,"source":"TRICKEST_TOKEN env var","email":"you@org.com","vault":"your-vault"}For interactive use you can log in once and have the token stored for you:
trickest auth loginSee Authentication for the full token model and precedence rules.
The mental model
Three ideas explain how almost every command behaves:
JSON by default
Every command prints compact JSON unless you pass --output table or
--output yaml. Pipe to jq and parse with confidence.
Structured errors + exit codes
Errors are a JSON envelope {code, message, hint} with a specific exit code
(auth, not-found, validation, …) so scripts can branch precisely.
Persistent context
The CLI remembers your active space and workflow. Workflow-scoped commands
(node, graph, save) act on "the current workflow" without repeating IDs.
A first session
export TRICKEST_TOKEN=<token>
trickest auth status # who am I?
trickest space ls # what spaces exist?
trickest switch /spaces/Solutions/workflows/"DAST v2" # set active context
trickest node ls # nodes in the active workflow
trickest graph analyze # DAG stats: layers, critical path, parallelism
trickest run ls # recent runsHow this section is organized
The left sidebar groups the CLI by what you're trying to do:
Discovering commands
The CLI is self-documenting. --help works at every level:
trickest --help # all top-level commands
trickest <command> --help # subcommands + options for a command
trickest <command> <subcommand> --helpThe full command surface is listed on the Command Index.
Conventions used throughout these docs
- Examples assume
TRICKEST_TOKENis set in your environment. - Output shown after a command is real output, trimmed for length and with IDs
abbreviated (e.g.
7b4a4059-…). - Put global flags before the subcommand:
trickest --output table node ls. [ ]marks optional arguments/flags;<>marks required ones.