Browse docs

CLI reference

Every command the Fluxmail CLI exposes for running the server and managing accounts, members, API keys, config, and licenses.

Running under Docker? Prefix any of these with docker compose exec fluxmail so the command runs inside the container, e.g. docker compose exec fluxmail fluxmail accounts list.

fluxmail serve                        # HTTP server (MCP at /mcp)
fluxmail stdio                        # stdio MCP server
fluxmail accounts add gmail           # OAuth consent flow; add --member <id-or-email> to set an owner
fluxmail accounts add gmail --reauthorize <account-id>
fluxmail accounts list | remove <id>
fluxmail accounts assign <id> --member <id-or-email>   # or --shared
fluxmail members add --name <name> [--email <email>]   # people using this instance
fluxmail members list | remove <id>
fluxmail apikey create --name <name>  # key for the HTTP endpoint (shown once); name it after the client using it
fluxmail apikey create --name <name> --member <id-or-email>
fluxmail apikey list | revoke <id>
fluxmail config set <KEY> <value>     # persist settings in the data dir
fluxmail config list | unset <KEY>
fluxmail license activate <key>       # unlock paid-plan limits
fluxmail license status | deactivate
fluxmail status