Sign-in and setup · MachineMail Docs

Commands that sign the CLI in and out, show and check the credential in use, and register an agent without a human.

Command	Summary
`login`	Sign in with the browser (or an API key) and save the key to a profile
`whoami`	Show the key, profile and API in use, and check the key
`doctor`	Check the config, connectivity, key, clock and CLI version
`register`	Register this agent (auth.md): a sandbox inbox and credentials, no human needed
`claim`	Get a new claim code for a registered agent, and wait for a human to claim it
`logout`	Remove the stored key from a profile, and optionally revoke it

Every command also takes the global flags.

Signs in with the browser: prints a code and a link (Enter opens it), you approve the code in the dashboard while signed in, and the API creates an API key named “CLI on <hostname>” (every permission except inbound_raw) that is saved to a profile in the config file (mode 0600). Without a terminal or a browser it prints the link and waits. For CI and scripts, give an existing key instead: —key - (stdin), —api-key -, or MACHINEMAIL_API_KEY; —paste asks for one with a hidden prompt. Given keys are checked against GET /v0/auth/me unless —no-verify. —profile keeps several keys side by side and —base-url points a profile at a local or self-hosted API. Agents without a human can start with machinemail register.

shell

machinemail login [flags]

Flags

--browserboolean

Offer to open the browser for sign-in (default; --no-browser only prints the URL).

--pasteboolean

Paste an existing API key into a hidden prompt instead of signing in with the browser.

--key <key|->string

The API key, or - to read it from stdin (keeps it out of shell history).

--with-keyboolean

Read the key from stdin (same as --key -).

--no-verifyboolean

Save the key without checking it against the API (offline setup).

Examples

shell

machinemail login
machinemail login --no-browser
printf %s "$MACHINEMAIL_API_KEY" | machinemail login --key -
machinemail login --profile staging --base-url https://staging.example.dev
machinemail login --profile local --base-url http://127.0.0.1:8080 --key - < key.txt

whoami

Show the key, profile and API in use, and check the key.

Shows the profile, API and key the CLI will use and where each came from (flag, env, profile or default), then checks the key with GET /v0/auth/me. Exits 3 when there is no key or the API rejects it.

shell

machinemail whoami

Examples

shell

machinemail whoami
machinemail whoami --profile staging
machinemail whoami --json | jq -r '.organization_id'

doctor

Check the config, connectivity, key, clock and CLI version.

Runs every check and reports each one: the config file and its permissions, the profile and API URL in use, whether a key is set, whether the API answers (GET /health and /health/ready), whether it accepts the key (GET /v0/auth/me), clock skew against the API, and the CLI version. Exits with the first failure (7 config, 6 network, 3 auth, 1 other), or 0. No key is ever printed unmasked, even with —verbose.

shell

machinemail doctor [flags]

Flags

--offlineboolean

Skip the checks that call the API.

Examples

shell

machinemail doctor
machinemail doctor --profile staging --verbose
machinemail doctor --json | jq '.checks[] | select(.status != "ok")'

register

Anonymous auth.md registration: creates a sandbox organization with one inbox on the shared domain, gets an access token and saves everything in a profile (renewed automatically). The sandbox reaches only its own inbox, can send a few messages to a few different recipients per 24 hours (deployment defaults: 10 messages, 10 recipients, 5 per message; the current caps are in auth.md), and expires after 24 hours unless a human claims it. The command starts a claim and prints a link and a 6-digit code for a human; —wait blocks until they finish, then switches to the post-claim credentials. Uses the current profile when it has no key, else a profile named “agent” (or —profile).

shell

machinemail register [flags]

Flags

--name <value>string

Agent name shown to the human at claim time.

--email <value>string

Only this person can claim the agent.

--claimboolean

Start a claim now (default; --no-claim to skip and run machinemail claim later).

--waitboolean

Wait until a human claims the agent.

--forceboolean

Replace a profile that holds an API key.

Examples

shell

machinemail register --name "Research agent"
machinemail register --email ada@acme.dev --wait
machinemail register --json | jq -r .inbox_id

claim

Get a new claim code for a registered agent, and wait for a human to claim it.

For a profile made by machinemail register: starts a claim (a link and a 6-digit code for a human, valid 10 minutes; earlier codes stop working) and, with —wait, blocks until the human finishes, then saves the post-claim credentials.

shell

machinemail claim [flags]

Flags

--email <value>string

Only this person can claim the agent.

--waitboolean

Wait until a human claims the agent.

Examples

shell

machinemail claim
machinemail claim --email ada@acme.dev --wait

logout

Remove the stored key from a profile, and optionally revoke it.

Deletes the stored key from the profile (the profile and its base URL stay), and for a registered agent the credentials that renew it. On a terminal it offers to revoke the key on the server first (DELETE /v0/api-keys/{id}); —revoke (or —yes) revokes without asking, —no-revoke keeps the key valid. Without a terminal the key is only removed locally unless —revoke or —yes is given.

shell

machinemail logout [flags]

Flags

--revokeboolean

Revoke the key on the server too (--no-revoke: only remove it here). Asks on a terminal.

Examples

shell

machinemail logout
machinemail logout --yes
machinemail logout --no-revoke --profile staging