utilities.md


title: "Utilities" description: "MachineMail CLI utility commands: open the dashboard in a browser, print a shell completion script for bash, zsh or fish, and print the CLI version." canonical: "https://machinemail.dev/docs/cli/commands/utilities"

Utilities

MachineMail CLI utility commands: open the dashboard in a browser, print a shell completion script for bash, zsh or fish, and print the CLI version.

Source: https://machinemail.dev/docs/cli/commands/utilities

Open the dashboard, print shell completions and print the CLI version.

Command Summary
open Open the dashboard in a browser
completion Print a shell completion script (bash, zsh, fish)
version Print the CLI version

Every command also takes the global flags.

open

Open the dashboard in a browser.

Opens the MachineMail dashboard (machinemail.dev). Pages: inboxes, threads, drafts, domains, webhooks, api-keys, lists, usage, settings. Without a browser (SSH, CI, a sandbox) it prints the URL. MACHINEMAIL_DASHBOARD_URL overrides the origin. The dashboard has its own sign-in; it does not use the CLI's API key.

machinemail open [page] [flags]

Arguments

Field Type Description
[page] string One of inboxes, threads, drafts, domains, webhooks, api-keys, lists, usage, settings

Flags

Field Type Description
--inbox <inbox-id> string Open this inbox.
--print boolean Print the URL instead of opening it.

Examples

machinemail open
machinemail open webhooks
machinemail open --inbox agent@machinemail.dev
machinemail open --print

completion

Print a shell completion script (bash, zsh, fish).

Prints a completion script generated from this build’s command tree: resources, actions, flags with their descriptions, enum values and profile names. Completing never runs the CLI. Regenerate it after upgrading.

machinemail completion <shell>

Arguments

Field Type Description
<shell> string required bash \\

Examples

machinemail completion bash > ~/.local/share/bash-completion/completions/machinemail
machinemail completion zsh > "${fpath[1]}/_machinemail"
machinemail completion fish > ~/.config/fish/completions/machinemail.fish
eval "$\(machinemail completion bash)"

version

Print the CLI version.

machinemail version