Installation

Requirements

Node.js 18 or later.
A package manager (npm, pnpm, yarn, or bun).
A Memax account (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 on your PATH.

memax --version

Authenticate

Interactive OAuth (GitHub or Google):

memax login

OAuth credentials (access token, refresh token) are stored in ~/.memax/credentials.json. Other CLI settings (api_url, default_hub, etc.) live in ~/.memax/config.json. Confirm sign-in with memax whoami.

API keys (non-interactive / CI)

For headless environments, generate an API key:

memax auth create-key "ci-token"

The printed key starts with mxk_ and is shown once — save it somewhere safe. Then export it:

export MEMAX_API_KEY=mxk_...

The CLI automatically uses MEMAX_API_KEY when set. There is no --api-key CLI flag.

Keep keys safe

API keys carry whatever scopes they were created with. Never commit them to version control; use env vars or a secret manager.

Configuration

Global config lives at ~/.memax/config.json. Manage it with:

memax config get            # show all values
memax config get <key>      # show one
memax config set <key> <value>

Per-project overrides go in a .memax.yml file at your repo root (the CLI walks up from the current directory to find it). It can set project_id (override git-origin-based project scope) and hub (default hub for this project).

# .memax.yml
project_id: github.com/my-org/my-repo
hub: platform-team

Environment variables

Only two env vars are read by the CLI today:

Variable	Purpose
`MEMAX_API_KEY`	Use this key instead of stored OAuth credentials.
`MEMAX_API_URL`	Point the CLI at a non-default backend. Overrides `api_url` in `~/.memax/config.json`. The default `api_url` stored by a fresh install is `http://localhost:8080`; set `MEMAX_API_URL=https://api.memax.app` (or configure via `memax config set api_url …`) to talk to production.

MEMAX_HUB, MEMAX_NO_COLOR, and MEMAX_DEBUG are not honored by the CLI today. Use memax hub switch, --hub, or .memax.yml hub: to control the default hub.

Updating

npm update -g memax-cli

Uninstalling

npm uninstall -g memax-cli
rm -rf ~/.memax/      # optional: also remove stored creds + config

On this page