Quickstart - boxd

Everything happens inside a machine. Open a shell on any of yours with boxd connect mybox, or use the console terminal. A machine created before automations shipped has no run command, so create a fresh machine if yours is that old.

Connect and discover

run                       # what's enabled for your team, and what's connected
run list                  # the full catalog of integrations you can connect
run auth linear           # connect one; prints a URL to approve in your browser
run search "create issue" # find the tool you need
run linear create-issue --help

run auth prints a link. Approve it in your browser and the CLI notices on its own. See Connections for personal versus shared connections.

Call a tool

run linear get-current-user
run linear list-issues --assignee-id me --json

Your first automation

mkdir my-automation && cd my-automation
run init                  # tsconfig.json for editor types + hello.run.ts
run hello.run.ts          # registers a 1-minute tick and goes to the background
run jobs                  # see it; run logs <id> -f to follow its output

Edit hello.run.ts into what you want and re-run the file. Re-running replaces the job in place.

Where next

Scripts for everything a *.run.ts file can import.
Jobs for states, retries, and sleep and wake.
The full CLI reference: run.