Skip to main content
Examples target CLI 0.6.134 and use your configured active profile. Save your organization and project once with Projects and profiles. The CLI reuses those settings, so everyday commands do not need --profile, --org-id, --project-id, or --json. Use IDs discovered in your own environment.

​
Common reads

List pages, Flows, tasks, or tables using your saved context:
Read a resource using an ID from its list:
Replace these placeholders with IDs returned by your service. Default auto output renders readable tables or values where appropriate and falls back to JSON for complex results. Resource-specific text, exports and streams retain their own output contracts.
Canvas --limit and --offset slice the fetched list locally; they do not fetch successive backend pages. The home pages list alias does not support these options. Task lists default to 100, allow at most 200 per request, and accept an offset. A first page is not a complete inventory; account for concurrent changes when collecting one.
To read table rows, supply the table ID and a backend query body:
Row values are nested under data. The body accepts inline JSON or @path/to/file.json; inspect the table’s columns and deployed query contract before authoring filters. See database tables for server pagination and output projection.

​
Find the right command

tp commands shows the command tree. These optional discovery tools also work without authentication:
--all includes top-level aliases. Prefer canonical paths such as tp auth whoami, tp context orgs, and tp mlops jobs list in automation.

​
Authentication

For interactive onboarding, set up and activate your connection and project:
Setup asks for a profile name and connection settings, authenticates, lists accessible organizations/projects by name with numbered choices, and saves after confirmation. Cancellation, empty access lists and authentication/API errors preserve saved configuration. It uses service reads only and requires an interactive terminal without JSON output or root --query. For an existing profile, use tp auth login to sign in again and tp auth whoami to verify identity. Agents and scripts should use a prepared profile or manual context setup, including configure --no-prompt with explicit settings and IDs. Login resolves a token and saves effective profile defaults; it does not grant new permissions. tp configure reviews and saves settings offline. Workspace delegation requires an appropriately provisioned managed workspace.

​
Saved context

Check the active profile, organization and project before starting work. The following commands use those saved defaults.
context use checks access and persists both IDs. Its command-local ID options are needed for initial selection, rather than repeated on every resource command. Replace work with an existing configured profile. Verify effective context before writes: selecting a saved profile does not switch the signed-in account or establish permission.

​
Preview, write, verify

These commands change resources when run without --dry-run. Review the context and payload first. A preview does not prove server authorization or successful validation; some update previews read the current resource.
The local file must exist. Capture the returned page ID and use it for the final read. For an existing page, --content-file replaces page blocks; --append-content-file appends a text block. Updates use updatedAt conflict protection unless --force is supplied. Resolve a conflict by reading and reconciling the current page before trying again.
Do not blindly retry a create, append, run, invoke, or delete after a timeout: the server may have completed it. Inspect resource state or operation status first. Retry reads only when appropriate for the error, with bounded backoff. A command’s presence or dry-run response does not imply idempotency.

​
Optional global settings

Keep the short commands above for ordinary use. To change a setting for one invocation, put global options before the command path:
This uses the existing staging profile for one invocation. To activate it for later short commands, use tp profile use staging.
Profile selection resolves from --profile, then the profile environment setting, then the active saved profile. Individual connection/context settings resolve from explicit flags, then environment settings, then the selected profile. Check tp context show if a saved setting appears to be ignored.
These global ID overrides affect only that invocation. They differ from the command-local required options after context use, which persist the selected context.

​
JSON, errors, and query behavior

You do not need --json for terminal reads. Request it explicitly when another program must parse a JSON result:
Keep stderr separate and check exit status before parsing. See scripting and output for an executable capture-and-parse example.
Handled authentication, API, missing-context, and value errors exit with status 1. In JSON mode they emit an error object on stderr, with ok: false and error; API errors may also include status_code and response_body. Command syntax errors typically exit 2 with text on stderr, even in JSON mode. Unexpected failures are not guaranteed to follow the handled-error schema. Downloads, logs, JSONL, help, and command-specific output modes may have different output contracts; inspect their help before piping to a JSON parser.
--query supports object keys and nonnegative list indices, not filters, wildcards, or full JSONPath/JMESPath. Quote expressions so the shell does not expand brackets. With --json, an extracted string is still a JSON string. Missing keys, out-of-range indices, and wrong value types are errors, not empty results.Projection happens after obtaining the result. A projection failure after a mutation does not mean the mutation failed; verify state before retrying. Some commands stream or emit directly and do not use shared projection.

​
Discover API operations

Operation IDs depend on the connected application. Discover an ID, inspect it, and preview the resolved request:
Replace OPERATION_ID with a discovered ID and supply its required parameters. See API requests for an example with a required job ID.
api call accepts repeated --path-param KEY=VALUE, repeated --query KEY=VALUE, and --body JSON or --body @file.json. Here --query is an HTTP query parameter because it follows api call; root --query before the command is an output projection. Resolve required parameters from api show before invoking an operation. Effective context fills organization/project parameters only when the operation defines them.Authenticated api call, raw, and rest requests accept relative paths or absolute URLs whose HTTP(S) origin exactly matches the configured API origin. Explicitly configured HTTP deployments are supported; HTTPS cannot be downgraded per request. Invalid or ambiguous URLs and origin mismatches fail before credential acquisition. Redirects are not followed.

​
Detailed workflow reference

Expand a command below for a short example followed by its full syntax and options. All examples use your active profile. A default of “not supplied” means the declaration leaves it unset; profiles, environment settings or the server can supply effective values. “Omitted” means no default is listed. Repeatable options consume one value per occurrence; variadic arguments consume multiple words. Set PLUGIN_ID and SKILL_ID from plugins list; set FLOW_ID and JOB_ID from the corresponding list commands. Local upload sources must exist. Export and preview examples write local files, signed-URL commands issue access URLs, and polling performs network reads. Flow and Data Lake mutation examples use --dry-run. Data Lake list --limit and --offset shape fetched results locally. Use --all to collect continuation pages first, or pass a returned continuation token explicitly. JSONL emits one record per line. Signed URLs grant access until expiry; retain them only where needed for the transfer. Flow payload fields depend on the selected Flow. Inspect its definition and input requirements before authoring flow-inputs.json. In the current release, Flow dry-run output names a different endpoint from the actual SDK request; treat it as a payload aid. See execution for that limitation.

​
Interactive profile setup

For a person using a terminal, discover accessible organizations and projects by name, then confirm saving and activating the profile. Cancellation or discovery failure leaves saved configuration unchanged. JSON, query and non-terminal setup are rejected before authentication; agents and scripts should use context discovery and configure —no-prompt instead.
Set up a saved profile without looking up organization or project IDs first.

​
Local plugin commands

Inspect bundled plugin and skill IDs before choosing an installation or export target. These commands operate on local bundled content. Installation and export write local files; install and install-skill support —dry-run. Export does not support —dry-run.
List the bundled plugin and its available skill IDs.
Display a bundled plugin manifest or a selected bundled file.
Match a task or command phrase against bundled guidance.
Inspect the local installation destinations for an agent target.
Install a bundled plugin into a selected local agent destination.
Install one bundled skill into a local skill destination.
Export a bundled plugin or skill as a directory or archive.

​
Data Lake file commands

Use the organization and project saved in your active profile. List and tree accept an empty read root; project-relative paths resolve in the active project for the read, upload and signed-URL helpers. Upload helpers reject another project namespace, parent traversal and writes to legacy/. Upload previews inspect local files, so their source paths must exist. The raw move and delete commands pass supplied paths to the API; use paths returned by a listing.
List child directories under a remote path.
List remote files and directories with continuation support.
Preview remote file content or save the response locally.
Resolve a remote path to its storage URI.
Plan or upload one local file.
Plan or upload the files in a local directory.
Preview or request a remote file or directory move.
Preview or request deletion of a remote file or directory.
Request signed download or upload URLs for one or more remote paths.
Request a signed URL for reading and listing a folder prefix.
Request a signed URL for uploading under a folder prefix.

​
Flow execution and job monitoring

Flow run starts work; jobs commands inspect existing jobs. Job wait and watch poll until a recognized terminal state or a supplied timeout. Both return exit status 1 for an unsuccessful terminal state or timeout. Log streaming can continue until the backend closes the stream and has no CLI timeout option. Log content uses a command-specific output path rather than the shared JSON result renderer.
Save the definition of an existing Flow and refresh its schemas.
flow_data: JSON object, inline or @file. Flow-specific definition; no universal server schema is asserted here.
Start an existing Flow with runtime inputs; the current dry-run preview has the limitation described below.
inputs: JSON object, inline or @file. Defined by the selected Flow; inspect that Flow before supplying inputs. In the current release the dry-run preview names a different endpoint from the actual SDK request; it is not an authoritative wire preview. See the execution guide.
Discover jobs in the selected context.
Read details for an existing job.
Fetch logs with optional text filtering and a local output file.
Stream logs until the backend completes the stream.
Fetch metrics for an existing job.
Poll an existing job until terminal status or timeout.
Poll an existing job and display progress in human output mode.

​
Complete command catalog

The catalog below lists command syntax, including aliases. Expand a family to find its precise positional syntax, then inspect the detailed workflow reference above, the downloadable metadata, or that path with --help for required options and accepted values. [OPTIONS] does not mean every option is optional: options marked [required] in help must be supplied. Download command and option metadata
This catalog targets CLI 0.6.134. The connected service determines which operations your account can perform. Use each command’s --help to inspect required inputs and output modes.