Installation

Install the Memax CLI and configure authentication. Covers npm, system requirements, and environment setup.

Requirements

Node.js 18 or later
npm, pnpm, yarn, or bun
A Memax account (sign up at memax.app)

Install the CLI

npm install -g memax-cli

pnpm add -g memax-cli

yarn global add memax-cli

bun add -g memax-cli

The package installs a memax binary in your global path.

memax --version
# memax-cli/0.x.x

Authentication

Authenticate with your Memax account:

memax login

This opens your default browser and walks you through OAuth (GitHub or Google). On success, credentials are stored in ~/.config/memax/.

Verify authentication

memax whoami

✓ Authenticated as alice@example.com
  Hub: alice's hub (personal)

API keys

For CI/CD or headless environments, use an API key instead of browser-based OAuth:

# Generate a key at memax.app → Settings → API Keys
export MEMAX_API_KEY=mk_...

# Or pass it directly
memax --api-key mk_... recall "how does auth work?"

Keep keys safe

API keys grant full access to your hub. Never commit them to version control. Use environment variables or secret managers.

Configuration

The CLI reads configuration from ~/.config/memax/config.json. You can also set config per-project using a .memaxrc file in your project root.

# View current config
memax config list

# Set a value
memax config set default_boundary private
memax config set default_hub hub_abc123

Environment variables

Variable	Description
`MEMAX_API_KEY`	API key for authentication (overrides OAuth)
`MEMAX_API_URL`	Custom API endpoint (default: `https://api.memaxlabs.com`)
`MEMAX_HUB`	Default hub ID
`MEMAX_NO_COLOR`	Disable colored output
`MEMAX_DEBUG`	Enable debug logging

Updating

npm update -g memax-cli

Uninstalling

npm uninstall -g memax-cli
# Optionally remove config
rm -rf ~/.config/memax/

On this page