Install the CLI
Get airpost and the other command-line programs, from the desktop app or on their own.
Airpost has no release yet. The install script, Homebrew formula, packages and archives below need the first vX.Y.Z release and don’t work until then. To use the CLI today, build it from source.
What gets installed
The command-line programs ship together:
| Program | What it is |
|---|---|
airpost | The CLI. |
airpost-engine | The sync engine. See The engine. |
airpost-mcp | The MCP server for AI agents. See Agents. |
airpost-gateway | The web client’s server. See Self-hosting. |
Packages and archives also include the built web client in share/airpost-gateway/web.
From the desktop app
The desktop app bundles its own engine and the airpost command. Turn on the airpost command in Preferences > General to link it onto your PATH. airpost uninstall removes that link again.
Without the desktop app
These are the planned install methods, once a release exists.
For macOS and Linux:
curl -fsSL https://github.com/airpost-mail/airpost/releases/latest/download/install.sh | sh
It picks the archive for your OS and CPU, checks it against the release’s SHA256SUMS, and installs to ~/.local/bin and ~/.local/share. Pass options after sh -s --:
| Option | Description |
|---|---|
--version 0.2.0 | Install a given release (default: the newest). |
--system | Install to /usr/local, with sudo. |
--prefix DIR | Install to DIR/bin and DIR/share. |
--uninstall | Remove what the script installed in that prefix. |
Upgrade by running it again, then airpost engine restart.
Windows isn’t supported: there is no Windows build of the engine, and its socket is a Unix socket only.
After installing
Run the engine in the background
airpost engine install
This installs a launchd or systemd user unit that starts the engine at login. See Background services.
Add an account
airpost account add you@example.com
IMAP accounts ask for a password; Gmail, Office 365 and Outlook (--provider gmail|office365|outlook) sign in in the browser. See account add.
Check it
airpost status
A working setup looks like this (accounts and paths are yours):
$ airpost --version
airpost 0.1.0
$ airpost status
ACCOUNT ID STATE SERVER PID UPTIME ENGINE
you@example.com 54500b8c running ok 51838 3m 0.1.0
SERVICE STATE PID URL BINARY
engine running 51838 - /Users/you/.local/bin/airpost-engine
gateway not installed - - -
mcp-http not installed - - -
On a server
On a machine without a desktop keyring, keep the engine’s secrets in a key file instead, and let your user units run without a login session:
airpost engine install --key-file ~/.config/airpost-engine.key
loginctl enable-linger "$USER"
Add OAuth accounts from a machine with no browser with airpost account add you@gmail.com --provider gmail --paste. Serving the web client from there is covered in Self-hosting.
Uninstall
airpost uninstall
This removes every unit airpost installed for the profile and the airpost link the desktop put on the PATH. Add --purge-profile to also delete the mail cache, accounts and settings.
Troubleshooting
Related: CLI overview, Background services, Agent skill.