Skip to main content
The maximem-synap CLI lets you provision and operate Synap from your terminal: log in, create and manage instances, mint API keys, manage your team, and inspect requests and memories — the same operations as the Dashboard, scriptable.
CLI vs SDK. The SDK is the runtime surface — your agents import it to read and write memory (recall, save, context). The CLI is the control plane — you use it to set Synap up and operate it. They are separate tools for separate jobs.

​
Install and log in

The CLI ships on npm as a small bootstrapper that installs the tool onto your PATH. The fastest start is a single command: 
npx @maximem/synap-cli@latest auth login
This installs the CLI (if it isn’t already) and starts the browser login. After the first run, the maximem-synap command is on your PATH: 
maximem-synap auth login
maximem-synap whoami
Requires Node.js 18+ and Python 3.10+ on the host. The CLI is dependency-light and stores its config under ~/.config/synap/config.json (mode 0600).

​
Logging in

Authentication is a browser device-pairing flow — like gcloud auth login. You never paste a key; your identity stays in the browser.
1

Run the login command

maximem-synap auth login
The CLI prints a short pairing code and opens your browser:
  Your pairing code is:  XYZA-BCDE
  Approve this login at: https://synap.maximem.ai/cli/pair?code=XYZA-BCDE

  Waiting for approval…
2

Approve in the browser

On the Synap dashboard pair page, confirm the code matches your terminal, pick the client to connect to, and click Approve. If you aren’t signed in, you’ll be prompted first.
3

You're in

The terminal confirms the login and stores the session under your active profile:
Logged in to client "Acme" · profile "default"
The minted key is bound to one client and expires after 90 days. Re-run maximem-synap auth login to refresh it.

​
Which account am I?

maximem-synap whoami        # client, scopes, key expiry, profile
maximem-synap auth list     # all logged-in accounts (active one starred)

​
Multiple accounts

Each profile holds one session bound to one client. Log into different clients under different profiles and switch between them: 
maximem-synap auth login --profile acme        # log into Acme
maximem-synap auth login --profile internal    # log into another client
maximem-synap auth use acme                     # switch the active profile

​
A quick tour

maximem-synap instances list                              # your memory instances
maximem-synap instances create --name "Support" --relationship b2c
maximem-synap api-keys create --instance <id> --label prod   # an SDK key, shown once
maximem-synap requests list --since 1h                    # what happened in the last hour
maximem-synap memories list --instance <id>               # inspect stored memories
maximem-synap client members list                         # your team
Add --output json to any command for scripting, and --help to any command for its options.
An API key minted with api-keys create is shown once and never again. Copy it immediately. This is the key your agents put in the SDK (SYNAP_API_KEY).

​
Logging out

maximem-synap auth logout      # revokes the key server-side and removes it locally

​
Next steps

Command reference

Every command and flag — auth, instances, api-keys, client, requests, memories, config.

Dashboard

The same operations in the web UI.