Quickstart

View as Markdown

Install the CLI, authenticate, and launch a cloud browser in six steps.

1. Install

$npm install -g @bctrl/cli
$bctrl version

2. Authenticate

$bctrl auth login
$bctrl auth status

In CI or an agent, set an API key instead:

$export BCTRL_API_KEY="bctrl_..."

3. Launch a runtime

$bctrl runtime create --name quickstart --json
$bctrl runtime start rt_123 --json

runtime start returns a run-scoped connectUrl and a runId. Pull just the connect URL with --jq:

$bctrl runtime start rt_123 --json --jq '.connectUrl'

4. Drive it

Either connect your own tooling to the connectUrl over CDP, or run a hosted agent invocation:

$bctrl runtime invocation create rt_123 \
>  --action extract \
>  --instruction "Extract the page title" \
>  --json

5. Inspect the run

$bctrl run get run_123 --json
$bctrl run events list run_123 --json
$bctrl run live run_123 --json

6. Stop the runtime

$bctrl runtime stop rt_123 --json

Next