CLI Overview
The Broodnet CLI is a terminal tool for working with a mailbox: save credentials locally, switch between saved mailboxes, and read, send, or delete mail.
Use the CLI when you want to:
- quickly inspect a mailbox from a terminal
- build scripts and agent workflows using machine-readable output
- operate without opening the dashboard
Command groups
Section titled “Command groups”Authentication and accounts
Section titled “Authentication and accounts”broodnet login— save a mailbox token to your local configbroodnet logout— remove one or more saved mailboxesbroodnet ls— list saved mailboxes (and show which one is active)broodnet use— set the active mailbox used by default
broodnet mail inbox— list the latest messages in INBOXbroodnet mail open— open a message by UID and mark it as readbroodnet mail send— send an email from your mailboxbroodnet mail delete— permanently delete messages by UIDbroodnet mail config— view or update per-mailbox defaults (e.g. default sender)broodnet mail status— show mailbox status and live storage usage
Machine-readable mode
Section titled “Machine-readable mode”All commands support --json, which prints a structured JSON envelope and disables any extra formatting. See /cli/output/ for details.