> ## Documentation Index
> Fetch the complete documentation index at: https://docs.emailx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the CLI

> Install the supported client from your Emailx deployment.

Use Python 3.11 or newer and a dedicated environment. The source archive is the supported distribution; a public package-registry name is not available.

```bash theme={null}
export EMAILX_BASE_URL="https://app.emailx.ai"
python3 -m venv .venv-emailx
. .venv-emailx/bin/activate
python -m pip install "$EMAILX_BASE_URL/api/emailx-agent.zip"
emailx --version
emailx --help
```

The base CLI does not import the Flask application or MCP SDK. To add local MCP later:

```bash theme={null}
python -m pip install "emailx-agent[mcp] @ $EMAILX_BASE_URL/api/emailx-agent.zip"
```

## Verify before accessing data

Configure a [scoped key](https://docs.emailx.ai/en/cli/authentication.md), then run `emailx doctor --json`. Doctor checks configuration and makes the authenticated `/me` call. `emailx auth status --json` also reads `/me`. Confirm the returned environment and account.

## Upgrades

Install a reviewed source archive from the same trusted deployment and check `emailx --version`. Read the [developer changelog](https://docs.emailx.ai/en/changelog/overview.md) for behavior changes. This reference describes package 0.11.0; the app version and CLI package version are separate, and a host may serve an older archive.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.