CLI Reference

The spideriq CLI includes a mail command group for reading mail from the terminal. It uses your signed-in credentials (see Authentication) and supports --format json|yaml|md on every command.

The CLI mail commands cover the read surface. Sending, replying, and forwarding are done through the send_email MCP tool or the job submission API.

spideriq mail mailboxes

List your connected mailboxes.

--format <format> (optional, default json) — json | yaml | md.
-w, --workspace <name> (optional, default default).

spideriq mail mailboxes --format yaml

spideriq mail list

List messages in a mailbox.

<mailbox-id> (argument, required) — mailbox id or email address.
--unread (optional) — show only unread messages.
--page <n> (optional, default 1).
--per-page <n> (optional, default 20).
--format <format> (optional, default json).
-w, --workspace <name> (optional, default default).

spideriq mail list alice@yourcompany.com --unread --per-page 50 --format yaml

spideriq mail read

Read a specific message.

<mailbox-id> (argument, required) — mailbox id or email address.
<message-id> (argument, required).
--format <format> (optional, default json).
-w, --workspace <name> (optional, default default).

spideriq mail read alice@yourcompany.com 5678 --format yaml

Tip: Set --format yaml for the same low-token output agents use. The default is json.

Next steps

MCP Tools for the full read and write surface, including sending.
API Reference for everything over HTTP.
Authentication to sign in.