docs: dedicate /platform/agent-signup page; rework introduction + nav
Per launch feedback (Deshraj, Mragank, Rudraj on 2026-05-16): - NEW: docs/platform/agent-signup.mdx — dedicated tutorial page. Owns the full Agent Mode story: 4-command demo, --agent-caller, mem0 identify fallback, claim flow, rate limits, what's-next links. - docs/docs.json: insert platform/agent-signup at position 2 in the Platform > Getting Started group (directly under platform/overview). - docs/introduction.mdx: the homepage card formerly labeled "CLI" and linking to /platform/cli now points to /platform/agent-signup with the headline "Sign up as an agent" — the first big call-to-action. - docs/platform/cli.mdx: stripped the Agent Mode promo block, the Plugin Sync section, the agent-related rows from the mem0 init flag table, and the entire mem0 identify subsection. Added a one-line wayfinding Tip + Note pointing readers to /platform/agent-signup. CLI page is now a clean reference for human dashboard users. - docs/platform/quickstart.mdx: reverted the duplicate 4-step block added in the earlier commit. Replaced with a one-line Note pointing to /platform/agent-signup. - README.md: closing pointer added to the existing Quickstart subtitle so the GitHub landing page lands readers in the docs.
This commit is contained in:
+6
-58
@@ -25,51 +25,11 @@ pip install mem0-cli
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Sign up as an agent
|
||||
|
||||
AI agents (Claude Code, Cursor, Codex, …) can mint a working Mem0 API key in under five seconds — no email, no dashboard, no OTP. Four commands end-to-end:
|
||||
|
||||
<CodeGroup>
|
||||
```bash npm
|
||||
# 1. Install
|
||||
npm install -g @mem0/cli
|
||||
|
||||
# 2. Sign up as an agent (replace `claude-code` with your name)
|
||||
mem0 init --agent --agent-caller claude-code
|
||||
|
||||
# 3. Add a memory
|
||||
mem0 add "I am using mem0"
|
||||
|
||||
# 4. Search
|
||||
mem0 search "am I using mem0"
|
||||
```
|
||||
|
||||
```bash pip
|
||||
# 1. Install
|
||||
pip install mem0-cli
|
||||
|
||||
# 2. Sign up as an agent (replace `claude-code` with your name)
|
||||
mem0 init --agent --agent-caller claude-code
|
||||
|
||||
# 3. Add a memory
|
||||
mem0 add "I am using mem0"
|
||||
|
||||
# 4. Search
|
||||
mem0 search "am I using mem0"
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
The human owner can claim the account later — same API key, memories preserved:
|
||||
|
||||
```bash
|
||||
mem0 init --email you@yourcompany.com
|
||||
```
|
||||
|
||||
<Tip>
|
||||
**Forgot `--agent-caller`?** Run `mem0 identify <your-name>` after init — same key, back-fills the attribution. Idempotent.
|
||||
**Looking for Agent Mode signup?** See [Sign up as an agent](/platform/agent-signup) — install, signup, first memory in four commands.
|
||||
</Tip>
|
||||
|
||||
## Authentication (humans)
|
||||
## Authentication
|
||||
|
||||
Run the interactive setup wizard to configure your API key:
|
||||
|
||||
@@ -123,7 +83,6 @@ Interactive setup wizard. Prompts for your API key and default user ID.
|
||||
mem0 init
|
||||
mem0 init --api-key m0-xxx --user-id alice
|
||||
mem0 init --email alice@company.com
|
||||
mem0 init --agent --agent-caller claude-code # zero-friction signup for AI agents
|
||||
```
|
||||
|
||||
If an existing configuration is detected, the CLI will ask for confirmation before overwriting. Use `--force` to skip the prompt (useful in CI/CD pipelines).
|
||||
@@ -136,24 +95,13 @@ mem0 init --api-key m0-xxx --user-id alice --force
|
||||
|------|-------------|
|
||||
| `--api-key` | API key (skip prompt) |
|
||||
| `-u, --user-id` | Default user ID (skip prompt) |
|
||||
| `--email` | Login via email verification code (also used to claim an Agent Mode key) |
|
||||
| `--email` | Login via email verification code |
|
||||
| `--code` | Verification code (use with `--email` for non-interactive login) |
|
||||
| `--agent` | Bootstrap an Agent Mode account — no email, no dashboard |
|
||||
| `--agent-caller` | Self-declared agent identity for Agent Mode signups (e.g. `claude-code`, `cursor`) |
|
||||
| `--source` | Channel attribution for analytics (e.g. `github`, `hn`, `ph`) |
|
||||
| `--force` | Overwrite existing config without confirmation |
|
||||
|
||||
### `mem0 identify`
|
||||
|
||||
Tag your active Agent Mode key with the AI agent that's using it. Run this once after `mem0 init --agent` if you didn't pass `--agent-caller` on init. Idempotent — re-running just overwrites the value.
|
||||
|
||||
```bash
|
||||
mem0 identify claude-code
|
||||
mem0 identify cursor
|
||||
mem0 identify my-custom-bot
|
||||
```
|
||||
|
||||
The CLI calls `PATCH /api/v1/auth/agent_mode/caller/` against the active key. Only works on unclaimed Agent Mode keys; the backend rejects with 400 otherwise. Agent names are sanitized server-side (lowercased, restricted to `[a-z0-9._/-]`, truncated to 32 chars).
|
||||
<Note>
|
||||
AI agents should use `mem0 init --agent` — see [Sign up as an agent](/platform/agent-signup).
|
||||
</Note>
|
||||
|
||||
### `mem0 add`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user