Unmeshed Logo

CLI & Remote Agents

CLI Run, Search, & Steps

These commands are useful when you want to test a flow from the terminal, inspect execution state without opening the UI, or push a worker-driven step forward from an external tool.

Run a process

Use run to start a process on the active server:

bash

Current behavior:

  • sync execution is the default
  • --async returns immediately
  • --sync is available if you want to be explicit
  • --interactive prompts for the process name, namespace, version, and JSON input

Useful flags:

  • --name
  • --namespace (defaults to default)
  • --version
  • --request-id
  • --correlation-id
  • --input
  • --input-file
  • --timeout for sync execution

Examples:

bash

Invoke an API mapping

Use call to trigger an API mapping endpoint:

bash

Important details from the current command behavior:

  • pass only the endpoint name, not a full URL
  • GET is the default method
  • POST accepts --input or --input-file
  • supported call types are SYNC, ASYNC, and STREAM

Examples:

bash

Search process and step data

Use search when you need either a targeted lookup or a filtered execution search.

Fetch one process or one step

bash

Search execution history with filters

Examples:

bash

Supported filter groups include:

  • namespace
  • process IDs
  • process types
  • trigger types
  • process names
  • step names
  • step refs
  • correlation IDs
  • request IDs
  • statuses
  • tags in key:value form
  • full-text query
  • pagination through --limit and --offset

Time filters are sent as epoch milliseconds, but the CLI renders returned timestamps in readable local time such as 2026-03-19 09:15:00 PDT.

Update step status

Use step update-status when an external system needs to move a step forward by step ref:

bash

The current command supports:

  • --status RUNNING
  • --status COMPLETED
  • --status FAILED

You can also attach a reason or output payload:

bash

Only step refs are supported by the current command. The CLI sends STEP_REF as the identifier type.

Related process support commands

When you need to act on running or failed executions rather than just inspect them, the CLI also exposes these process subcommands:

  • unmeshed process terminate --process-ids 123,456
  • unmeshed process resume --process-ids 123,456
  • unmeshed process reviewed --process-ids 123,456 --reason "Reviewed by ops"
  • unmeshed process resume-version --process-id 123 --version 2
  • unmeshed process remove-step --process-id 123 --step-id 456

Related Documentation