Quickstart

This is the recommended first run. It creates an inbox, saves CLI credentials locally, links the inbox to your web account, and proves that mail is flowing.

1. Install the CLI

/bin/bash -c "$(curl -fsSL https://get.dispatchjoin.com/install_dispatch.sh)"

Verify installation:

dispatch --version

If you are using a non-production API during development, pass --api-url on commands or set DISPATCH_API_URL.

2. Create Your First Inbox

dispatch inbox create my-first-inbox

The CLI provisions a workspace and inbox, then saves local credentials. The text output shows the workspace id, inbox id, and address. Check local state any time:

dispatch status

3. Claim the Inbox in the Web App

dispatch inbox claim --open

The claim link opens the Dispatch setup flow. Sign in or create an account, verify your email if prompted, then complete the link. Claiming makes the workspace visible in Mail Desk and Billing.

If the browser does not open, copy the link_url from the command output.

4. Send Mail Into the Inbox

Send a test email from any mailbox to the Dispatch address printed by dispatch inbox create.

Watch for it:

dispatch mail tail

List recent messages:

dispatch mail ls

5. Extract the Latest Code or Link

dispatch mail code
dispatch mail link

Use --folder spam if the message was filtered.

6. Send a Test Reply

dispatch mail reply latest --text "Hello from Dispatch"

Finish State

You are ready when:

• dispatch status shows a workspace or inbox session.
• dispatch inbox show returns the selected inbox.
• dispatch mail ls can see inbound mail.
• The web app shows the claimed workspace.

Next: Read and Search Mail or Plans and Usage.