Get Started with Tapicker Bridge

This guide connects one browser Extension to a local Bridge, then starts a Workflow from your terminal.

Requirements

  • Node.js 22 or later. Check your version with node --version.
  • The Tapicker Extension installed in Chrome or another supported Chromium-based browser.
  • A Tapicker Workflow whose ID you can copy.

Install and Start Bridge

Install the CLI globally:

npm install --global @tapicker/bridge

Start Bridge in the foreground:

tapicker bridge start

Keep this terminal open. Bridge prints its HTTP and WebSocket addresses and a four-digit pairing code. By default, it listens on 127.0.0.1 and tries ports 9520 through 9530; use the actual address printed by your process if it selected a different port.

Connect Your Extension

  1. Open the Tapicker Extension and go to Settings > General.
  2. Turn on Bridge.
  3. Click Scan to find a local Bridge automatically. To connect manually, enter the WebSocket endpoint printed by Bridge (for example, ws://127.0.0.1:9520/ws) and click Connect.
  4. When prompted, enter the four-digit pairing code shown in the Bridge terminal.

The Extension remembers the pairing credential, so you do not need to enter the code again after a Bridge restart. The code is for pairing a new Extension.

Check that the Extension is ready:

tapicker bridge extensions

If Bridge selected a port other than 9520, add --port <port> to this command and subsequent CLI commands.

If you started Bridge with --daemon, use tapicker bridge code to display the current pairing code.

Run a Workflow

Copy the Workflow ID from Tapicker, then run:

tapicker workflow start <workflowId> --watch

For example:

tapicker workflow start jr657xeb --watch

The command prints the start response and then streams status updates until the Workflow completes, stops, or fails. --watch only waits for updates; pressing Ctrl+C or reaching a watch timeout does not stop the Workflow.

If Bridge selected a port other than 9520, pass that port to Workflow commands:

tapicker workflow start jr657xeb --port 9521 --watch

Stop Bridge

Press Ctrl+C in the foreground terminal. For background operation, start Bridge with --daemon and stop it later with:

tapicker bridge stop

What’s Next?

On This Page