Skip to main content
The CLI requires an access key to authenticate with the Xpoz MCP server. Get your key from the Xpoz dashboard.

Login

1

Get your access key

Sign up or log in at xpoz.ai and copy your access key from the Settings page.
2

Store the key

xpoz-cli auth login
You will be prompted to enter your access key. The key is stored locally in a config file (see Config File Location below).
3

Verify

xpoz-cli auth status
Confirms that a valid access key is stored and shows your account status.

Logout

Remove the stored access key:
xpoz-cli auth logout

Auth Commands

CommandDescription
xpoz-cli auth loginStore your access key
xpoz-cli auth statusCheck authentication status
xpoz-cli auth logoutRemove stored credentials

Credential Precedence

The CLI resolves credentials in this order:
  1. --api-key flag — highest priority, overrides everything
  2. XPOZ_API_KEY environment variable — useful for CI/CD and scripting
  3. Stored config file — set by xpoz-cli auth login
# Use a specific key for one command
xpoz-cli twitter get_user --identifier elonmusk --api-key sk-your-key

# Or set the environment variable
export XPOZ_API_KEY=sk-your-key
xpoz-cli twitter get_user --identifier elonmusk
For CI/CD pipelines and automation, use the XPOZ_API_KEY environment variable. For local development, auth login is more convenient.

Config File Location

~/.config/xpoz/config.json
The file is created with 0600 permissions (owner read/write only) to protect your access key.
The config file contains your access key in plain text. Do not commit it to version control. The CLI sets restrictive file permissions (0600) on Linux and macOS to prevent other users on the system from reading it.

Next Steps

Usage

Start querying platforms with the CLI.

MCP Authentication

Set up the same access key with the MCP server directly.