Control Tapicker Workflows from the CLI

After Bridge is running and an Extension is ready, you can control a Workflow from any terminal that can reach the Bridge.

Find the Workflow ID

Use Tapicker’s Copy ID action on the Workflow you want to run. The Workflow ID is different from its display name; use the ID in Bridge commands.

Start a Workflow

tapicker workflow start <workflowId> [options]

For example, pass Workflow arguments as a JSON object and wait for status updates:

tapicker workflow start jr657xeb \
  --args '{"keyword":"Tapicker"}' \
  --watch

By default, a Workflow starts in the active browser tab. You can open a new tab or target an existing tab:

tapicker workflow start jr657xeb --tab new
tapicker workflow start jr657xeb --tab id:123

The start response includes the workflowId, full workflowName, and selected clientId. A Workflow start is accepted asynchronously; use --watch if the caller needs to observe its lifecycle.

Control a Running Workflow

Use the same Workflow ID to control its active instance:

tapicker workflow pause jr657xeb
tapicker workflow resume jr657xeb
tapicker workflow stop jr657xeb

The Extension currently allows one active instance of a given Workflow. Bridge does not start a second instance of the same Workflow in that Extension.

Check Status or Watch Updates

Get one status snapshot:

tapicker workflow status jr657xeb

Watch an already-started Workflow:

tapicker workflow watch jr657xeb

Or start and watch in one command:

tapicker workflow start jr657xeb --watch

The watch commands stream updates until the Workflow reaches completed, stopped, or failed. Add --timeout <milliseconds> to limit how long the CLI waits. A timeout or Ctrl+C ends the watch only; it does not stop the Workflow. For reconnect behavior and the raw WebSocket protocol, see Workflow status events.

Choose an Extension

If exactly one ready Extension is connected, Bridge selects it automatically. If multiple Extensions are ready, first list them:

tapicker bridge extensions

Then pass the intended Extension’s clientId:

tapicker workflow start jr657xeb \
  --client-id 56a450e6-41f1-448e-9ea7-a2d958cbda37

The same --client-id option is available for pause, resume, stop, status, watch, and data commands. Bridge does not broadcast a Workflow command to every connected Extension.

On This Page