| name | memory-cli-reference |
| description | Full Memory CLI command reference with all subcommands and flags. Use when you need exact command syntax, flag names, or usage examples for any `memory` CLI command. |
| metadata | {"author":"emergent","version":"1.0"} |
This skill contains the complete memory CLI command reference, auto-generated from the binary.
Use this when you need to look up:
- Exact subcommand names (e.g.
memory agents get-run, memory provider configure-project)
- Available flags and their types for any command
- Usage examples embedded in the help text
- Which subcommands exist under a parent command
Memory CLI Reference
Full command reference auto-generated from memory --help. Each section covers one command or subcommand with its synopsis, usage, and flags.
memory
CLI tool for Memory platform
Synopsis
Command-line interface for the Memory knowledge base platform.
Manage projects, documents, graph objects, AI agents, and MCP integrations.
For self-hosted deployments, use 'memory server' to install and manage your server.
Options
--compact use compact output layout
--config string config file (default is $HOME/.memory/config.yaml)
--debug enable debug logging
-h, --help help for memory
--no-color disable colored output
--output string output format (table, json, yaml, csv) (default "table")
--project string project ID (overrides config and environment)
--project-token string project token (overrides config and environment)
--server string Memory server URL
memory adk-sessions
Manage and inspect ADK sessions
Synopsis
Manage and inspect Google ADK (Agent Development Kit) sessions.
ADK sessions represent individual agent conversation threads, including the full
event history of messages and tool calls. Use the list subcommand to browse
sessions for a project, and the get subcommand to inspect a specific session in
detail.
Options
-h, --help help for adk-sessions
--project string Project name or ID
memory adk-sessions get
Get details and event history for a specific ADK session
Synopsis
Get full details and the complete event history for a specific ADK session.
Outputs the entire session record as indented JSON, including all events (user
messages, agent responses, and tool calls) in the session history.
memory adk-sessions get [id] [flags]
Options
-h, --help help for get
memory adk-sessions list
List ADK sessions for the active project
Synopsis
List all ADK sessions for the active (or specified) project.
Each session is printed on one line with its session ID, App name, User ID, and
last Updated timestamp in the format:
ID: | App: | User: | Updated:
memory adk-sessions list [flags]
Options
-h, --help help for list
memory agent-definitions
Manage agent definitions
Synopsis
Commands for managing agent definitions (system prompts, tools, model config, flow type, visibility)
Options
-h, --help help for agent-definitions
memory agent-definitions create
Create a new agent definition
Synopsis
Create a new agent definition.
Examples:
memory agent-definitions create --name "my-def" --system-prompt "You are a helpful agent"
memory defs create --name "extractor" --flow-type single --tools "search,graph_query" --visibility project
memory agent-definitions create [flags]
Options
--default-timeout int Default timeout in seconds
--description string Description
--flow-type string Flow type (single, multi, coordinator)
-h, --help help for create
--is-default string Set as default definition (true/false)
--max-steps int Maximum steps per run
--model string Model name (e.g., gemini-2.0-flash)
--name string Definition name (required)
--system-prompt string System prompt
--tools string Comma-separated tool names
--visibility string Visibility (external, project, internal)
memory agent-definitions delete
Delete an agent definition
Synopsis
Delete an agent definition by ID
memory agent-definitions delete [id] [flags]
Options
-h, --help help for delete
memory agent-definitions get
Get agent definition details
Synopsis
Get full details for a specific agent definition by ID.
Prints Name, ID, ProjectID, FlowType, Visibility, IsDefault, Description (if
set), System Prompt (truncated to 200 characters), Model configuration (Name,
Temperature, MaxTokens), Tools list, MaxSteps, DefaultTimeout, ACP Config
(DisplayName, Description, Capabilities), CreatedAt and UpdatedAt timestamps,
and any extra Config JSON.
memory agent-definitions get [id] [flags]
Options
-h, --help help for get
memory agent-definitions list
List all agent definitions
Synopsis
List all agent definitions for the current project.
Prints a numbered list with each definition's Name, ID, FlowType, Visibility,
IsDefault flag, Tool count, and Description (if set).
memory agent-definitions list [flags]
Options
-h, --help help for list
memory agent-definitions override
View or set per-project agent overrides
Synopsis
View or set per-project configuration overrides for an agent definition.
Without flags, shows the current override for the agent. With flags, sets
or updates the override. Overrides are merged on top of canonical defaults
each time the agent runs — non-overridden fields always get the latest code defaults.
Examples:
memory defs override graph-query-agent # view current override
memory defs override graph-query-agent --model gemini-2.5-pro # override model
memory defs override cli-assistant-agent --max-steps 30 # override max steps
memory defs override graph-query-agent --model gemini-2.5-pro --temperature 0.2 --max-steps 20
memory defs override graph-query-agent --system-prompt-file prompt.txt
memory defs override graph-query-agent --sandbox-enabled false # disable sandbox
memory defs override graph-query-agent --clear # remove override
memory agent-definitions override [agentName] [flags]
Options
--clear Remove override — revert to canonical defaults
-h, --help help for override
--max-steps int Override max steps
--model string Override model name (e.g., gemini-2.5-pro)
--sandbox-enabled string Override sandbox enabled state (true/false)
--system-prompt string Override system prompt
--system-prompt-file string Read system prompt from file
--temperature float32 Override temperature (0.0-2.0) (default -1)
--tools string Override tools (comma-separated)
memory agent-definitions overrides
List all agent overrides for the project
Synopsis
List all per-project agent configuration overrides.
memory agent-definitions overrides [flags]
Options
-h, --help help for overrides
memory agent-definitions update
Update an agent definition
Synopsis
Update an existing agent definition (partial update)
memory agent-definitions update [id] [flags]
Options
--default-timeout int New default timeout
--description string New description
--flow-type string New flow type
-h, --help help for update
--is-default string Set as default (true/false)
--max-steps int New max steps
--model string New model name
--name string New name
--system-prompt string New system prompt
--tools string New comma-separated tool names
--visibility string New visibility
memory agents
Manage runtime agents
Synopsis
Commands for managing runtime agents (scheduling, triggers, execution state)
Options
-h, --help help for agents
--project string Project name or ID (auto-detected from config/env if not specified)
memory agents builtin-tools
Manage built-in tools
Synopsis
Commands for managing built-in (Go-native) tools in the Memory platform.
Built-in tools are implemented directly in the server and are available to all
agents without requiring an external MCP server connection. Examples include
query_entities, brave_web_search, webfetch, and create_document.
Use 'memory agents mcp-servers' to manage externally-connected MCP servers.
Options
-h, --help help for builtin-tools
memory agents builtin-tools configure
Set runtime config for a built-in tool
Synopsis
Set runtime configuration key/value pairs for a named built-in tool.
Looks up the tool by name and patches its config. Only the provided keys are
updated; existing keys not mentioned are left unchanged.
Examples:
memory agents builtin-tools configure brave_web_search api_key=YOUR_KEY
memory agents builtin-tools configure reddit_search client_id=ID client_secret=SECRET
memory agents builtin-tools configure [tool-name] [key=value ...] [flags]
Options
-h, --help help for configure
memory agents builtin-tools list
List all built-in tools
Synopsis
List all built-in tools registered for the current project.
Prints each tool's enabled/disabled state, name, and description. Tools that
require runtime configuration (e.g. API keys) are shown with their config status.
The 'Source' column shows where the effective settings come from: project, org,
or global (server default).
memory agents builtin-tools list [flags]
Options
-h, --help help for list
memory agents builtin-tools toggle
Enable or disable a built-in tool
Synopsis
Enable or disable a built-in tool for the current project.
The tool-id is the UUID shown in 'memory agents builtin-tools list'.
Examples:
memory agents builtin-tools toggle off
memory agents builtin-tools toggle on
memory agents builtin-tools toggle [tool-id] [on|off] [flags]
Options
-h, --help help for toggle
memory agents create
Create a new agent
Synopsis
Create a new runtime agent for the current project.
Examples:
memory agents create --name "my-agent" --project
memory agents create --name "cron-agent" --trigger-type schedule --cron "0 */5 * * * *"
memory agents create --name "reaction-agent" --trigger-type reaction --reaction-events created,updated --reaction-object-types document
memory agents create [flags]
Options
--cron string Cron schedule (e.g., '0 */5 * * * *')
--description string Agent description
--enabled string Enable agent (true/false)
--execution-mode string Execution mode
-h, --help help for create
--name string Agent name (required)
--prompt string Agent prompt
--reaction-events string Comma-separated reaction event types (e.g., created,updated)
--reaction-object-types string Comma-separated reaction object types (e.g., document,chunk)
--strategy-type string Strategy type (e.g., graph_object_processor)
--trigger-type string Trigger type (manual, schedule, reaction, webhook)
memory agents delete
Delete an agent
Synopsis
Delete an agent by ID.
Prints "Agent deleted successfully." on success.
memory agents delete [id] [flags]
Options
-h, --help help for delete
memory agents get-run
Get details for a specific run
Synopsis
Get full details for a specific agent run by its run ID. Output includes:
- Run ID, agent ID, status, start/end times
- Token usage: total input tokens, total output tokens
- Estimated cost in USD
- Root run ID (for sub-runs triggered by a parent run)
- Any output or error message from the run
No --project flag is required — run IDs are globally unique.
This is the primary command to check the cost of a specific agent run.
memory agents get-run [run-id] [flags]
Options
-h, --help help for get-run
--json Output result as JSON
memory agents get
Get agent details
Synopsis
Get full details for a specific agent by its ID.
Prints Name, ID, Project ID, Strategy Type, Enabled status, Trigger Type,
Execution Mode, Cron Schedule (if set), Description (if set), Prompt (if set),
Reaction Config (Object Types and Events), Last Run At, Last Run Status,
Created At, Updated At, and any extra Config JSON.
memory agents get [id] [flags]
Options
-h, --help help for get
memory agents hooks
Manage agent webhook hooks
Synopsis
Commands for managing webhook hooks on agents (create, list, delete)
Options
-h, --help help for hooks
memory agents hooks create
Create a webhook hook
Synopsis
Create a new webhook hook for an agent. The plaintext token is only shown once.
Examples:
memory agents hooks create --label "CI/CD Pipeline"
memory agents hooks create --label "Staging" --rate-limit 30 --burst-size 5
memory agents hooks create [agent-id] [flags]
Options
--burst-size int Burst size for rate limiting (0 = server default)
-h, --help help for create
--label string Hook label (required)
--rate-limit int Rate limit in requests per minute (0 = server default)
memory agents hooks delete
Delete a webhook hook
Synopsis
Delete a webhook hook from an agent
memory agents hooks delete [agent-id] [hook-id] [flags]
Options
-h, --help help for delete
memory agents hooks list
List webhook hooks
Synopsis
List all webhook hooks configured for an agent.
Prints a numbered list with each hook's Label, ID, Enabled status, Rate Limit
configuration (requests/minute and burst size, if set), and Created timestamp.
memory agents hooks list [agent-id] [flags]
Options
-h, --help help for list
memory agents list
List all agents
Synopsis
List all agents configured for the current project.
Prints a numbered list with each agent's Name, ID, Enabled status, Trigger
Type, Cron schedule (if any), Description (if set), Last Run timestamp, and
Last Run Status. Use --project to specify a project other than the active one.
memory agents list [flags]
Options
-h, --help help for list
memory agents mcp-servers
Manage MCP servers
Synopsis
Commands for managing Model Context Protocol (MCP) servers in the Memory platform
Options
-h, --help help for mcp-servers
memory agents mcp-servers configure
Configure a tool's runtime settings
Synopsis
Set runtime configuration key/value pairs for a named MCP tool.
The command searches all MCP servers in the current project to find the tool
by name, then patches its config with the provided key=value pairs.
Examples:
memory agents mcp-servers configure brave_web_search api_key=YOUR_KEY --project
memory agents mcp-servers configure reddit_search client_id=YOUR_ID client_secret=YOUR_SECRET --project
memory agents mcp-servers configure [tool-name] [key=value ...] [flags]
Options
-h, --help help for configure
memory agents mcp-servers create
Create a new MCP server
Synopsis
Register a new MCP server with the specified configuration.
Examples:
memory agents mcp-servers create --name "my-server" --type sse --url "http://localhost:8080/sse"
memory agents mcp-servers create --name "stdio-server" --type stdio --command "npx" --args "-y,@modelcontextprotocol/server-github"
memory agents mcp-servers create --name "my-server" --type http --url "http://localhost:8080/mcp" --env "API_KEY=abc123"
memory agents mcp-servers create [flags]
Options
--args string Comma-separated arguments (for stdio type)
--command string Command to run (for stdio type)
--description string Server description
--enabled string Enable server (true/false, default: true)
--env strings Environment variables (KEY=VALUE format, can be specified multiple times)
-h, --help help for create
--name string Server name (required)
--type string Server type: 'sse', 'stdio', or 'http' (required)
--url string Server URL (for sse/http types)
memory agents mcp-servers delete
Delete an MCP server
Synopsis
Remove an MCP server and all its tools from your project configuration
memory agents mcp-servers delete [server-id] [flags]
Options
-h, --help help for delete
memory agents mcp-servers get
Get MCP server details
Synopsis
Get full details for a specific MCP server, including its registered tools.
Prints Name (enabled/disabled), ID, Project ID, Description (if set), Type,
URL (for sse/http), Command and Args (for stdio), Env Vars count, Headers count,
Created, and Updated timestamps. Also lists all registered tools with their
enabled/disabled state and description (truncated to 60 characters).
memory agents mcp-servers get [server-id] [flags]
Options
-h, --help help for get
memory agents mcp-servers inspect
Inspect an MCP server
Synopsis
Test connection to an MCP server and display its capabilities, tools, prompts, and resources
memory agents mcp-servers inspect [server-id] [flags]
Options
-h, --help help for inspect
memory agents mcp-servers list
List all MCP servers
Synopsis
List all MCP servers configured for the current project.
Prints a numbered list with each server's Name (enabled/disabled), Description
(if set), ID, Type (sse/http/stdio), URL or Command, Tool count, and Created
timestamp.
memory agents mcp-servers list [flags]
Options
-h, --help help for list
memory agents mcp-servers sync
Sync tools from an MCP server
Synopsis
Connect to the MCP server and refresh the list of available tools
memory agents mcp-servers sync [server-id] [flags]
Options
-h, --help help for sync
memory agents mcp-servers tools
List tools for an MCP server
Synopsis
List all tools registered for a specific MCP server.
Each tool entry shows its enabled/disabled state and tool name. Use
'memory agents mcp-servers sync ' first to discover available tools if the list
is empty.
memory agents mcp-servers tools [server-id] [flags]
Options
-h, --help help for tools
memory agents questions
Manage agent questions
Synopsis
Commands for listing and responding to agent questions
Options
-h, --help help for questions
memory agents questions list-project
List questions for a project
Synopsis
List all agent questions for the current project.
Outputs the full question list as indented JSON. Use --status to filter by
question status (e.g. pending, answered).
memory agents questions list-project [flags]
Options
-h, --help help for list-project
--status string Filter by status (pending, answered, cancelled, expired)
memory agents questions list
List questions for a run
Synopsis
List all questions asked by the agent during a specific run.
Outputs the full question list as indented JSON, including each question's ID,
status, prompt text, and response (if already answered).
memory agents questions list [run-id] [flags]
Options
-h, --help help for list
memory agents questions respond
Respond to a question
Synopsis
Respond to a pending agent question and resume the paused agent run.
Sends the response text as the answer to the specified question. Outputs the
updated question record as indented JSON on success.
memory agents questions respond [question-id] [response] [flags]
Options
-h, --help help for respond
memory agents runs
List agent runs
Synopsis
List recent runs for an agent. Each run entry shows:
- Run ID and status (running, completed, failed)
- Start time and duration
- Token usage: input tokens / output tokens
- Estimated cost in USD (e.g. "Cost: $0.001234")
Use --limit to control how many runs are returned (default 10).
Use "memory agents get-run [run-id]" to get the full breakdown for a specific run.
memory agents runs [id] [flags]
Options
-h, --help help for runs
--limit int Maximum number of runs to return (default 10)
memory agents trigger
Trigger an agent run
Synopsis
Trigger an immediate run of an agent.
Prints "Agent triggered successfully!" with an optional message on success, or
"Agent trigger failed." with an error message on failure.
memory agents trigger [id] [flags]
Options
-h, --help help for trigger
memory agents update
Update an agent
Synopsis
Update an existing agent (partial update)
memory agents update [id] [flags]
Options
--cron string New cron schedule
--description string New description
--enabled string Enable/disable (true/false)
--execution-mode string New execution mode
-h, --help help for update
--name string New agent name
--prompt string New agent prompt
--trigger-type string New trigger type
memory ask
Ask the Memory CLI assistant a question or request a task
Synopsis
Ask the Memory CLI assistant a question or request a task.
The assistant is context-aware — it adapts its responses based on whether you
are authenticated and whether a project is configured:
• Not authenticated → documentation answers; explains how to log in
• Auth, no project → account-level tasks + documentation answers
• Auth + project active → full task execution + documentation answers
The assistant fetches live documentation from the Memory docs site to answer
questions about the CLI, SDK, REST API, agents, and knowledge graph features.
It can also execute tasks on your behalf (list agents, query the graph, etc.).
Examples:
memory ask "what are native tools?"
memory ask "what agents do I have configured?"
memory ask "how do I create a schema?"
memory ask --project abc123 "list all agent runs from today"
memory ask "what commands are available for managing API tokens?"
memory ask <question> [flags]
Options
-h, --help help for ask
--json Output result as JSON {question, response, tools, elapsedMs}
--project string Project ID (optional — uses default project if configured)
--runtime string Sandbox runtime for scripting tasks: python (default) or go
--show-time Show elapsed time at the end of the response
--show-tools Show tool calls made by the assistant during reasoning
--v2 Use the v2 code-generation agent (fewer round-trips, faster)
memory blueprints
Apply Blueprints (packs, agents, seed data) from a directory or GitHub URL
Synopsis
Apply Blueprints — schemas, agent definitions, skills, and seed data — to the
current project from a structured directory or a GitHub repository URL.
The source directory (or GitHub repo root) may contain:
packs/ — one file per memory schema (.json, .yaml, .yml)
agents/ — one file per agent definition (.json, .yaml, .yml)
skills/ — one subdirectory per skill, each containing a SKILL.md file
seed/objects/ — per-type JSONL files with graph objects to seed
seed/relationships/ — per-type JSONL files with graph relationships to seed
Skills follow the agentskills.io open standard: each skill is a directory with a
SKILL.md file containing YAML frontmatter (name, description) and Markdown content.
By default the command is additive-only: existing resources are skipped.
Use --upgrade to update resources that already exist.
Use the dump subcommand to export an existing project's data as seed files:
memory blueprints dump
Examples:
memory blueprints ./my-config
memory blueprints https://github.com/acme/memory-blueprints
memory blueprints https://github.com/acme/memory-blueprints#v1.2.0 --upgrade
memory blueprints ./my-config --dry-run
memory blueprints dump ./exported
memory blueprints <source> [flags]
Options
--dry-run Preview actions without making any API calls
-h, --help help for blueprints
--project string Project ID or name (overrides config/env)
--token string GitHub personal access token (for private repos); also read from MEMORY_GITHUB_TOKEN
--upgrade Update existing resources instead of skipping them
memory blueprints dump
Export project graph objects and relationships as JSONL seed files
Synopsis
Export the current project's graph objects and relationships as per-type JSONL
seed files that can be re-applied with "memory blueprints
".
Output layout:
/seed/objects/.jsonl
/seed/relationships/.jsonl
Files exceeding 50 MB are automatically split:
.001.jsonl, .002.jsonl, …
Examples:
memory blueprints dump ./exported
memory blueprints dump ./exported --types Document,Person
memory blueprints dump ./exported --project my-project
memory blueprints dump <output-dir> [flags]
Options
-h, --help help for dump
--project string Project ID or name (overrides config/env)
--types string Comma-separated list of object/relationship types to export (default: all types)
memory browse
Interactive TUI for browsing projects and documents
Synopsis
Launch an interactive terminal UI (TUI) for browsing projects, documents, and extractions.
The TUI provides:
- Tab-based navigation (Projects, Documents, Worker Stats, Template Packs, Query, Extractions, Traces)
- Natural language query (Ctrl+Q) to ask questions about your project
- Vim-style keybindings (j/k for up/down, Enter to select)
- Search functionality (press / to search)
- Help panel (press ? to toggle)
Minimum terminal size: 80x24
The Traces tab connects to the Grafana Tempo instance that runs alongside the configured
server. The Tempo URL is derived automatically from the server URL (same host, port 3200).
Override with --tempo-url or MEMORY_TEMPO_URL if Tempo runs elsewhere.
memory browse [flags]
Options
-h, --help help for browse
--tempo-url string Override Tempo URL (auto-derived from server URL by default)
memory completion
Generate shell completion scripts
Synopsis
Generate shell completion scripts for Memory CLI.
The completion script provides:
- Command and subcommand completion
- Flag name completion
- Flag value completion for enum flags (e.g., --output)
- Dynamic resource completion (project names, document IDs)
To load completions:
Bash:
$ source <(memory completion bash)
To load completions for each session, execute once:
Linux:
$ memory completion bash > /etc/bash_completion.d/memory
macOS:
$ memory completion bash > $(brew --prefix)/etc/bash_completion.d/memory
Zsh:
If shell completion is not already enabled in your environment,
you will need to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for each session, execute once:
$ memory completion zsh > "${fpath[1]}/_memory"
You will need to start a new shell for this setup to take effect.
Fish:
$ memory completion fish | source
To load completions for each session, execute once:
$ memory completion fish > ~/.config/fish/completions/memory.fish
PowerShell:
PS> memory completion powershell | Out-String | Invoke-Expression
To load completions for every new session, run:
PS> memory completion powershell > memory.ps1
and source this file from your PowerShell profile.
Notes:
- Dynamic completions (project names, document IDs) are cached locally for 5 minutes
- Cache location: ~/.memory/cache/
- Completion timeout: 2 seconds (configurable via ~/.memory/config.yaml)
memory completion [bash|zsh|fish|powershell]
Options
-h, --help help for completion
memory config
Manage CLI configuration
Synopsis
Configure server URL, credentials, and other settings for the Memory CLI
Options
-h, --help help for config
memory config set-credentials
Set the email for authentication
Synopsis
Set the email address used for authentication in the CLI configuration file.
Prints the email that was set and the path to the configuration file where
the setting was saved.
memory config set-credentials [email] [flags]
Options
--config string config file path
-h, --help help for set-credentials
memory config set-server
Set the Memory server URL
Synopsis
Set the Memory server URL in the CLI configuration file.
Prints the new server URL and the path to the configuration file where the
setting was saved. Use this to point the CLI at a different server environment
(e.g. local dev vs production).
memory config set-server [url] [flags]
Options
--config string config file path
-h, --help help for set-server
memory config set
Set a configuration value
Synopsis
Set a configuration value by key.
Supported keys:
server_url Server URL (e.g., http://localhost:3002)
api_key API key for authentication
email Email for authentication
org_id Organization ID
project_id Project ID
google_api_key Google API key (standalone installations only)
For standalone installations, google_api_key is saved to .env.local.
All other keys are saved to config.yaml.
memory config set <key> <value> [flags]
Options
--config string config file path
-h, --help help for set
memory config show
Display current configuration
Synopsis
Display the current CLI configuration as a table.
Prints a Setting/Value table with: Server URL, API Key (masked, showing only
the first 8 and last 4 characters), Email, Organization ID, Project ID, Debug
mode, and the Config File path. Values are merged from the config file and any
overriding environment variables.
memory config show [flags]
Options
--config string config file path
-h, --help help for show
memory documents
Manage project documents
Synopsis
Commands for managing documents in the Memory platform
Options
-h, --help help for documents
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
memory documents delete
Delete a document
Synopsis
Delete a document and all related entities.
Prints the deletion status and a summary of removed entities: Chunks,
Extraction jobs, Graph objects, and Graph relationships. Use --output json
for a machine-readable response.
memory documents delete <id> [flags]
Options
-h, --help help for delete
memory documents get
Get a document by ID
Synopsis
Get details for a specific document by its ID.
Prints ID, Filename, MIME Type, Size (bytes), Conversion Status, total Chunks,
Embedded Chunks, and Created/Updated timestamps. Use --output json to receive
the full document record as JSON instead.
memory documents get <id> [flags]
Options
-h, --help help for get
memory documents list
List documents
Synopsis
List documents in the current project.
Output is a table with columns: ID, Filename, MIME Type, Size (bytes), and
Created date. Use --limit to control how many records are returned. Use
--output json to receive the full document list as JSON.
memory documents list [flags]
Options
-h, --help help for list
--limit int Maximum number of results (default 50)
memory documents upload
Upload a file as a document
Synopsis
Upload a local file and create a document record. Use --auto-extract to trigger extraction after upload.
memory documents upload <file> [flags]
Options
--auto-extract Trigger extraction after upload
-h, --help help for upload
memory embeddings
Manage embedding workers
Synopsis
Inspect and control the embedding workers running in the Memory server.
Useful for benchmarking: pause all workers before a bench run so embeddings
don't interfere with write throughput, then resume afterwards.
Examples:
memory embeddings status Show current worker state
memory embeddings pause Pause all embedding workers
memory embeddings resume Resume all embedding workers
memory embeddings pause --server http://your-server:3002
Options
--config-path string path to Memory config.yaml
-h, --help help for embeddings
--server string Memory server URL (overrides config)
memory embeddings config
Get or set embedding worker config (batch, concurrency, stale-minutes)
Synopsis
Get or update embedding worker configuration at runtime without restarting.
All flags are optional — omit a flag to leave that value unchanged.
With no flags, shows the current configuration.
Examples:
memory embeddings config Show current config
memory embeddings config --batch 200 --concurrency 200 Max throughput
memory embeddings config --stale-minutes 60 Raise stale threshold
memory embeddings config --batch 10 --concurrency 10 Throttle down
memory embeddings config [flags]
Options
--batch int Number of jobs to dequeue per poll (0 = no change)
--concurrency int Number of jobs processed concurrently per poll (0 = no change)
-h, --help help for config
--interval-ms int Polling interval in milliseconds (0 = no change)
--stale-minutes int Minutes before a processing job is marked stale (0 = no change)
memory embeddings pause
Pause all embedding workers (object, relationship, sweep)
Synopsis
Pause all embedding workers (objects, relationships, and sweep).
Prints a confirmation message from the server, then displays the updated worker
state table showing each worker's status symbol (running ●, paused ⏸, stopped ○)
and the current Config (batch_size, concurrency, interval_ms, stale_minutes).
memory embeddings pause [flags]
Options
-h, --help help for pause
memory embeddings resume
Resume all embedding workers
Synopsis
Resume all paused embedding workers (objects, relationships, and sweep).
Prints a confirmation message from the server, then displays the updated worker
state table showing each worker's status symbol (running ●, paused ⏸, stopped ○)
and the current Config (batch_size, concurrency, interval_ms, stale_minutes).
memory embeddings resume [flags]
Options
-h, --help help for resume
memory embeddings status
Show pause/run state of all embedding workers
Synopsis
Show the current state of all embedding workers.
Prints a worker state table for the objects, relationships, and sweep workers.
Each worker is shown with a symbol indicating its state: running (●), paused (⏸),
or stopped (○). Also displays the current worker Config: batch_size, concurrency,
interval_ms, and stale_minutes.
memory embeddings status [flags]
Options
-h, --help help for status
memory graph
Manage graph objects and relationships
Synopsis
Commands for managing graph objects and relationships in the Memory knowledge graph
Options
-h, --help help for graph
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
memory graph objects
Manage graph objects
Options
-h, --help help for objects
memory graph objects create-batch
Batch-create graph objects from a JSON file
Synopsis
Create multiple graph objects in one API call.
The input file must contain a JSON array of objects, each with:
type (string, required)
name (string, optional) — placed in properties.name
description (string, optional) — placed in properties.description
properties (object, optional) — arbitrary additional properties
Example objects.json:
[
{"type": "Person", "name": "Alice"},
{"type": "Person", "name": "Bob", "description": "A developer"},
{"type": "Project", "name": "Acme", "properties": {"status": "active"}}
]
Output (one line per object):
memory graph objects create-batch [flags]
Options
--file string Path to JSON file containing array of objects (required)
-h, --help help for create-batch
memory graph objects create
Create a graph object
Synopsis
Create a new graph object with the given type and optional properties
memory graph objects create [flags]
Options
--description string Set properties.description
-h, --help help for create
--name string Set properties.name
--properties string JSON properties object
--type string Object type (required)
memory graph objects delete
Delete a graph object
Synopsis
Soft-delete a graph object by ID
memory graph objects delete <id> [flags]
Options
-h, --help help for delete
memory graph objects edges
Show edges (relationships) for an object
Synopsis
Show all incoming and outgoing relationships for a graph object.
Prints two sections: Outgoing (format: [Type] → DstID (entity: EntityID)) and
Incoming (format: [Type] ← SrcID (entity: EntityID)) with counts for each.
Use --output json to receive the full edges response as JSON.
memory graph objects edges <id> [flags]
Options
-h, --help help for edges
memory graph objects get
Get a graph object by ID
Synopsis
Get details for a graph object (entity) by its ID.
Prints Entity ID, Version ID, Type, Version number, Key (if set), Status (if
set), Labels (if any), Created timestamp, and Properties as formatted JSON.
Use --output json to receive the full object as JSON instead.
memory graph objects get <id> [flags]
Options
-h, --help help for get
--output string Output format: table or json (default "table")
memory graph objects list
List graph objects
Synopsis
List graph objects (entities) in the current project.
Output is a table with columns: Entity ID, Type, Version, Status, and Created
date. Use --type to filter by object type, --limit to control result count, and
--output json to receive the full list as JSON.
memory graph objects list [flags]
Options
-h, --help help for list
--limit int Maximum number of results (default 50)
--type string Filter by object type
memory graph objects update
Update a graph object
Synopsis
Update a graph object's properties or status (creates a new version)
memory graph objects update <id> [flags]
Options
-h, --help help for update
--properties string JSON properties object to merge
memory graph relationships
Manage graph relationships
Options
-h, --help help for relationships
memory graph relationships create-batch
Batch-create graph relationships from a JSON file
Synopsis
Create multiple graph relationships in one API call.
The input file must contain a JSON array of objects, each with:
type (string, required) — relationship type
from (string, required) — source entity ID
to (string, required) — destination entity ID
properties (object, optional)
Example relationships.json:
[
{"type": "knows", "from": "", "to": ""},
{"type": "manages", "from": "", "to": ""}
]
Output (one line per relationship): ->
memory graph relationships create-batch [flags]
Options
--file string Path to JSON file containing array of relationships (required)
-h, --help help for create-batch
memory graph relationships create
Create a relationship
Synopsis
Create a directed relationship between two graph objects
memory graph relationships create [flags]
Options
--from string Source object ID (required)
-h, --help help for create
--properties string JSON properties object
--to string Destination object ID (required)
--type string Relationship type (required)
memory graph relationships delete
Delete a relationship
Synopsis
Soft-delete a graph relationship by ID
memory graph relationships delete <id> [flags]
Options
-h, --help help for delete
memory graph relationships get
Get a relationship by ID
Synopsis
Get details for a graph relationship by its ID.
Prints Entity ID, Version ID, Type, From (source entity ID), To (destination
entity ID), Version number, Created timestamp, and Properties as formatted
JSON. Use --output json to receive the full relationship as JSON instead.
memory graph relationships get <id> [flags]
Options
-h, --help help for get
memory graph relationships list
List relationships
Synopsis
List relationships in the current project.
Output is a table with columns: Entity ID, Type, From (source entity ID), To
(destination entity ID), and Created date. Use --type to filter by relationship
type, --from/--to to filter by endpoint, --limit to control result count, and
--output json to receive the full list as JSON.
memory graph relationships list [flags]
Options
--from string Filter by source object ID
-h, --help help for list
--limit int Maximum number of results (default 50)
--to string Filter by destination object ID
--type string Filter by relationship type
memory init
Initialize a Memory project in the current directory
Synopsis
Interactive wizard that sets up a Memory project in the current directory.
Walks through:
- Project selection or creation
- LLM provider configuration (org-level)
- Memory skills installation for AI agents
Writes MEMORY_PROJECT_ID, MEMORY_PROJECT_NAME, and MEMORY_PROJECT_TOKEN
to .env.local and auto-adds .env.local to .gitignore.
Running 'memory init' again detects existing configuration and offers
to verify or reconfigure each step.
Use --skip-provider or --skip-skills to skip individual steps.
memory init [flags]
Options
-h, --help help for init
--skip-provider skip LLM provider configuration step
--skip-skills skip Memory skills installation step
memory install-memory-skills
Install Memory skills to .agents/skills/
Synopsis
Install the built-in Memory skills from the embedded catalog into
.agents/skills/ in the current directory (or the directory specified by --dir).
Only skills with the "memory-" prefix are installed. This is the set of skills
that teach AI agents how to use the Memory CLI and platform.
By default the command skips skills that already exist. Use --force to
overwrite existing skill directories.
memory install-memory-skills [flags]
Options
--dir string target directory (default: .agents/skills relative to cwd)
--force overwrite existing skill directories
-h, --help help for install-memory-skills
memory login
Sign in or create a Memory account
Synopsis
Authenticate using the OAuth Device Authorization flow.
Opens your browser so you can sign in or create a new account.
Your credentials are saved locally for future CLI use.
If this server is running in standalone mode, use an API key instead:
memory config set-api-key
memory login [flags]
Options
-h, --help help for login
memory logout
Clear stored credentials
Synopsis
Remove locally stored OAuth credentials and log out from the Memory platform.
Before deleting local credentials, attempts to revoke tokens server-side via
the OIDC revocation endpoint. Revocation is best-effort — if it fails, local
credentials are still removed.
Use --all to also clear api_key and project_token from your config file,
removing all locally stored authentication state.
memory logout [flags]
Options
--all Also clear api_key and project_token from config
-h, --help help for logout
memory mcp-guide
Show MCP configuration for AI agents
Synopsis
Print ready-to-use MCP server configuration snippets for connecting AI agents to Memory.
Outputs JSON configuration blocks for Claude Desktop, Cursor, and other MCP-
compatible clients. Snippets use the active server URL and API key (project
token takes precedence over account key). Copy the relevant block into your
AI client's MCP configuration to enable Memory tools.
memory mcp-guide [flags]
Options
-h, --help help for mcp-guide
memory projects
Manage projects
Synopsis
Commands for managing projects in the Memory platform
Options
-h, --help help for projects
memory projects create-token
Create a new API token for a project
Synopsis
Create a new project-scoped API token (emt_...) and print it.
The token is also written to .env.local in the current directory as
MEMORY_PROJECT_TOKEN so subsequent CLI commands pick it up automatically.
Scopes default to: data:read data:write schema:read agents:read agents:write
Example:
memory projects create-token my-project --name onboard-token
memory projects create-token [project-name-or-id] [flags]
Options
-h, --help help for create-token
--name string Token name (default "cli-token")
--no-env Do not write token to .env.local
--scopes strings Token scopes (default: data:read,data:write,schema:read,agents:read,agents:write)
memory projects create
Create a new project
Synopsis
Create a new project in the Memory platform.
Prints the new project's Name and ID on success. If no LLM provider credentials
are configured for the organization, a warning is shown explaining that AI
features (embeddings, search, extraction) will not work until a provider is
added via 'memory provider configure'.
memory projects create [flags]
Options
--description string Project description
-h, --help help for create
--name string Project name (required)
--org-id string Organization ID (auto-detected if not specified)
memory projects delete
Delete a project
Synopsis
Permanently delete a project and all its data
memory projects delete [project-id] [flags]
Options
-h, --help help for delete
memory projects get
Get project details
Synopsis
Get details for a specific project by name or ID.
Prints the project's Name, ID, and Org ID. If a project info document is set
it is shown as well. Use the --stats flag to additionally display counts for
Documents, Graph Objects, Relationships, Extraction jobs, and installed Schemas
with their object and relationship type names.
memory projects get [name-or-id] [flags]
Options
-h, --help help for get
--stats Include project statistics (documents, objects, jobs, schemas)
memory projects list
List all projects
Synopsis
List all projects you have access to.
Output prints a numbered list with each project's Name and ID. If the project
has a project info document set, it is shown beneath the name. Use the --stats
flag to also display per-project counts for Documents, Graph Objects,
Relationships, Extraction jobs (total/running/queued), and installed Schemas
(with their object and relationship type names).
memory projects list [flags]
Options
--filter string Filter results (e.g., 'name=MyProject,status=active')
-h, --help help for list
--limit int Maximum number of results (default from config)
--offset int Number of results to skip
--search string Search projects by name or description
--sort string Sort results (e.g., 'name:asc' or 'updated_at:desc')
--stats Include project statistics (documents, objects, jobs, schemas)
memory projects set-budget
Set a monthly spend budget for a project
Synopsis
Set or clear the monthly spend budget for a project.
When the project's estimated spend for the current month exceeds
budget_usd * budget_alert_threshold (default 0.8), an in-app notification
is sent to all org members. Set --budget 0 to clear an existing budget.
Examples:
memory projects set-budget my-project --budget 50
memory projects set-budget my-project --budget 100 --threshold 0.9
memory projects set-budget --budget 25
memory projects set-budget [project-name-or-id] [flags]
Options
--budget float Monthly budget in USD (set to 0 to clear)
-h, --help help for set-budget
--threshold float Alert threshold as a fraction of budget (e.g. 0.8 = 80%) (default 0.8)
memory projects set-info
Set the project info document
Synopsis
Set the project info document — a Markdown description of this project's
purpose, goals, audience, and context. Agents and MCP clients read this via the
get_project_info tool to orient themselves before working with the project's data.
Provide content via --file (read a .md file) or --text (inline string).
If no project is specified, the active project from config/env is used.
Examples:
memory projects set-info --file README.md
memory projects set-info my-project --file docs/project-info.md
memory projects set-info --text "This project tracks internal HR documents."
memory projects set-info [project-name-or-id] [flags]
Options
--file string Path to a Markdown file to use as project info
-h, --help help for set-info
--text string Inline project info text
memory projects set-provider
Configure the LLM provider for a project
Synopsis
Configure the LLM provider credentials for a specific project.
Supported providers: google, google-vertex. Prints the provider name, the
configured generative model, and the embedding model on success. Use flags
such as --api-key, --embedding-model, and --generative-model to specify
credentials and model overrides.
memory projects set-provider [project-name-or-id] <provider> [flags]
Options
--api-key string Google AI API key (for google)
--embedding-model string Override embedding model for this project
--gcp-project string GCP project ID (for google-vertex)
--generative-model string Override generative model for this project
-h, --help help for set-provider
--location string GCP region (for google-vertex)
--sa-file string Path to Vertex AI service account JSON (for google-vertex)
memory projects set
Set active project
Synopsis
Set the active project context.
Updates project_id in ~/.memory/config.yaml and writes MEMORY_PROJECT_ID,
MEMORY_PROJECT_NAME, and MEMORY_PROJECT_TOKEN into .env.local in the current
directory so that subsequent CLI commands and application code automatically use
the selected project. If no existing token is found for the project, a new one
is created automatically. Run without arguments to select interactively from a
numbered list of available projects.
Use --clear to remove the active project from the global config.
memory projects set [name-or-id] [flags]
Options
--clear Clear the active project from config
-h, --help help for set
memory provider
Manage LLM provider credentials and models
Synopsis
Commands for managing LLM provider credentials, model selections, and usage reporting.
Options
-h, --help help for provider
memory provider configure-project
Save project-level LLM provider credentials (overrides org config)
Synopsis
Save project-specific credentials and model selections for the given provider.
This overrides the organization's provider config for this project.
Use --remove to remove the project-level override and fall back to the org config.
Supported providers:
google — Google AI (Gemini API); requires --api-key
google-vertex — Google Cloud Vertex AI; requires --gcp-project, --location
The project is read from --project or the MEMORY_PROJECT_ID environment variable.
Examples:
memory provider configure-project google --api-key AIzaSy...
memory provider configure-project google-vertex --gcp-project my-proj --location us-central1 --key-file sa.json
memory provider configure-project google --remove
memory provider configure-project <provider> [flags]
Options
--api-key string API key (required for google)
--embedding-model string Embedding model to use (auto-selected from catalog if omitted)
--gcp-project string GCP project ID (required for google-vertex)
--generative-model string Generative model to use (auto-selected from catalog if omitted)
-h, --help help for configure-project
--key-file string Path to service account JSON key file (google-vertex)
--location string GCP region, e.g. us-central1 (required for google-vertex)
--project string Project ID (auto-detected from MEMORY_PROJECT_ID)
--remove Remove the project-level override and inherit org config
memory provider configure
Save LLM provider credentials and model selections for the organization
Synopsis
Save LLM provider credentials (and optionally model selections) for the
current organization. Runs a live credential test and syncs the model catalog
on success. Models are auto-selected from the catalog if not specified.
Supported providers:
google — Google AI (Gemini API); requires --api-key
google-vertex — Google Cloud Vertex AI; requires --gcp-project, --location
Optionally supply --key-file for a service account JSON key.
Examples:
memory provider configure google --api-key AIzaSy...
memory provider configure google-vertex --gcp-project my-project --location us-central1 --key-file sa.json
memory provider configure google --api-key AIzaSy... --generative-model gemini-2.5-flash --embedding-model text-embedding-004
memory provider configure <provider> [flags]
Options
--api-key string API key (required for google)
--embedding-model string Embedding model to use (auto-selected from catalog if omitted)
--gcp-project string GCP project ID (required for google-vertex)
--generative-model string Generative model to use (auto-selected from catalog if omitted)
-h, --help help for configure
--key-file string Path to service account JSON key file (google-vertex)
--location string GCP region, e.g. us-central1 (required for google-vertex)
--org-id string Organization ID (auto-detected from config)
memory provider list
Show current provider configurations
Synopsis
List all configured LLM providers at the organization level, plus any
project-level overrides across all projects in the organization.
The output is a table with columns: SCOPE, PROVIDER, GENERATIVE MODEL,
EMBEDDING MODEL, GCP PROJECT, LOCATION, and UPDATED.
Examples:
memory provider list
memory provider list --org-id
memory provider list --json
memory provider list [flags]
Options
-h, --help help for list
--json Output raw JSON
--org-id string Organization ID (auto-detected from config)
memory provider models
List available models from the provider catalog
Synopsis
List models available in the cached model catalog.
Without a provider argument, lists models for all configured providers.
Pass a provider name to filter to a single provider.
Use --type to filter by model type (embedding or generative).
Examples:
memory provider models
memory provider models google-vertex
memory provider models google --type generative
memory provider models [provider] [flags]
Options
-h, --help help for models
--org-id string Organization ID (auto-detected from config)
--type string Filter by model type: embedding or generative
memory provider test
Test LLM provider credentials with a live generate call
Synopsis
Send a live "say hello" generate call to verify that provider credentials
work end-to-end.
Without a provider argument, tests all configured providers.
Pass a provider name (google or google-vertex) to test a specific one.
Use --project to test using the project-level credential hierarchy
(project override → org) instead of org credentials only.
Examples:
memory provider test
memory provider test google-vertex
memory provider test google --project
memory provider test [provider] [flags]
Options
-h, --help help for test
--org-id string Organization ID (auto-detected from config)
--project string Project ID for project-level credential resolution
memory provider timeseries
Show LLM usage over time
Synopsis
Show LLM token usage and estimated cost broken down by time period.
Without --project, reports org-wide usage. With --project, reports usage for
that specific project. Use --granularity to control bucket size (default: day).
Output is a table with columns: PERIOD, PROVIDER, MODEL, TEXT IN, IMAGE, VIDEO,
AUDIO, OUTPUT, and EST. COST (USD). A running subtotal is shown per period.
Examples:
memory provider timeseries
memory provider timeseries --project --granularity week
memory provider timeseries --since 2024-01-01 --until 2024-03-31 --granularity month
memory provider timeseries [flags]
Options
--granularity string Time bucket size: day, week, or month (default "day")
-h, --help help for timeseries
--json Output raw JSON
--org-id string Organization ID (auto-detected from config)
--project string Filter to a specific project ID
--since string Start date (YYYY-MM-DD)
--until string End date (YYYY-MM-DD)
memory provider usage
Show LLM usage and estimated cost
Synopsis
Show aggregated LLM token usage and estimated cost.
Without --project, reports org-wide usage across all projects.
With --project, reports usage for that specific project.
Use --by-project to break org-wide totals down per project instead of per model.
Output is a table with columns: PROVIDER, MODEL, TEXT IN (tokens), IMAGE
(tokens), VIDEO (tokens), AUDIO (tokens), OUTPUT (tokens), and EST. COST (USD).
A total estimated cost line is printed below the table.
Examples:
memory provider usage
memory provider usage --project
memory provider usage --since 2024-01-01
memory provider usage --by-project
memory provider usage [flags]
Options
--by-project Break down org usage by project instead of by model
-h, --help help for usage
--json Output raw JSON
--org-id string Organization ID (auto-detected from config)
--project string Filter usage to a specific project ID
--since string Start date for usage window (YYYY-MM-DD)
--until string End date for usage window (YYYY-MM-DD)
memory query
Query a project using natural language
Synopsis
Query a project using natural language.
By default, uses the graph-query-agent — an AI agent that reasons over the knowledge
graph using search, traversal, and entity tools. The agent is managed server-side;
no agent ID is needed.
Use --mode=search for direct hybrid search without AI reasoning.
Examples:
memory query "what are the main services and how do they relate?"
memory query --mode=search "auth service"
memory query --project abc123 "list all requirements"
memory query <question> [flags]
Options
--debug Include debug information in output
--fusion-strategy string Fusion strategy: weighted, rrf, interleave, graph_first, text_first (search mode only) (default "weighted")
-h, --help help for query
--json Output results as JSON
--limit int Maximum number of results to return (search mode only) (default 10)
--mode string Query mode: agent (default, AI reasoning) or search (direct hybrid search) (default "agent")
--project string Project ID to query (uses default project if not specified)
--result-types string Types of results: graph, text, or both (search mode only) (default "both")
--show-scores Show relevance scores for each result (search mode only)
--show-time Show elapsed query time
--show-tools Show tool calls made by the agent (agent mode only)
memory schemas
Manage schemas
Synopsis
Commands for managing schemas in the Memory platform
Options
-h, --help help for schemas
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
memory schemas compiled-types
Show compiled object and relationship types for the current project
Synopsis
Show the merged set of type definitions compiled from all installed schemas.
Prints two tables: Object Types (columns: Name, Label, Schema, Description)
and Relationship Types (columns: Name, Label, Source → Target, Schema). Use
--output json to receive the raw compiled types as JSON.
memory schemas compiled-types [flags]
Options
-h, --help help for compiled-types
memory schemas create
Create a schema from a JSON file
Synopsis
Create a new schema by loading its definition from a JSON file
memory schemas create [flags]
Options
--file string Path to schema JSON file (required)
-h, --help help for create
memory schemas delete
Delete a schema from the registry
Synopsis
Permanently delete a schema definition from the global registry
memory schemas delete <schema-id> [flags]
Options
-h, --help help for delete
memory schemas get
Get a schema by ID
Synopsis
Get details for a schema pack by its ID.
Prints ID, Name, Version, Description (if set), Author (if set), Draft status,
and Created timestamp. Use --output json to receive the full schema record as
JSON instead.
memory schemas get <schema-id> [flags]
Options
-h, --help help for get
memory schemas install
Install a schema into the current project
Synopsis
Install a schema into the current project.
Two modes:
install Install an existing schema from the registry by ID.
install --file schema.json Create a new schema from a JSON file and install it in one step.
memory schemas install [<schema-id>] [flags]
Options
--dry-run Preview what would be installed without making changes
--file string Create schema from JSON file and install in one step
-h, --help help for install
--merge Additively merge incoming type schemas into existing registered types
memory schemas installed
List installed schemas
Synopsis
List schemas currently installed (assigned) on the current project.
Output is a table with columns: Assignment ID, Schema ID, Name, Version,
Active (yes/no), and Installed date. The Assignment ID is used with
'memory schemas uninstall' to remove a schema from the project. Use
--output json to receive the full list as JSON.
memory schemas installed [flags]
Options
-h, --help help for installed
memory schemas list
List available schemas
Synopsis
List schemas available in the global registry for the current project to install.
Output is a table with columns: ID, Name, Version, and Description (truncated
to 60 characters). Use --output json to receive the full list as JSON.
memory schemas list [flags]
Options
-h, --help help for list
memory schemas uninstall
Uninstall (remove) a schema assignment from the current project
Synopsis
Remove a schema assignment from the current project by its assignment ID.
Use 'memory schemas installed' to list assignment IDs. Prints
"Schema assignment removed." on success.
memory schemas uninstall <assignment-id> [flags]
Options
-h, --help help for uninstall
memory server
Manage a self-hosted Memory server
Synopsis
Commands for installing, running, and maintaining a self-hosted Memory server.
Options
-h, --help help for server
memory server ctl
Control Memory services
Synopsis
Control and manage Memory standalone services.
This command provides service management capabilities similar to memory-ctl:
- start/stop/restart services
- view service status and logs
- check server health
- open shell in server container
Examples:
memory ctl start
memory ctl stop
memory ctl status
memory ctl logs -f
memory ctl logs server
memory ctl health
Options
--dir string Installation directory (default "/root/.memory")
-h, --help help for ctl
memory server ctl health
Check server health
Synopsis
Check the health of the local Memory server.
Makes an HTTP GET request to the server's /health endpoint and prints whether
the server is healthy (✓) or not responding (✗). On a healthy response the
full JSON health payload is printed in indented format.
memory server ctl health [flags]
Options
-h, --help help for health
memory server ctl logs
Show service logs
Synopsis
Show logs from Memory services.
Examples:
memory ctl logs # Show recent logs from all services
memory ctl logs -f # Follow logs in real-time
memory ctl logs server # Show logs from server only
memory ctl logs -n 50 # Show last 50 lines
memory server ctl logs [service] [flags]
Options
-f, --follow Follow log output
-h, --help help for logs
-n, --lines int Number of lines to show (default 100)
memory server ctl pull
Pull latest Docker images
memory server ctl pull [flags]
Options
-h, --help help for pull
memory server ctl restart
Restart all services
memory server ctl restart [flags]
Options
-h, --help help for restart
memory server ctl shell
Open shell in server container
memory server ctl shell [flags]
Options
-h, --help help for shell
memory server ctl start
Start all services
memory server ctl start [flags]
Options
-h, --help help for start
memory server ctl status
Show service status
Synopsis
Show the current status of all Memory Docker services.
Runs 'docker compose ps' for the local installation and prints the container
name, state (running/exited), and port mappings for each service.
memory server ctl status [flags]
Options
-h, --help help for status
memory server ctl stop
Stop all services
memory server ctl stop [flags]
Options
-h, --help help for stop
memory server doctor
Check system health and configuration
Synopsis
Run diagnostic checks on your Memory CLI installation.
This command verifies:
- Configuration file exists and is valid
- Server connectivity
- Authentication status
- API functionality
- Docker container health (for standalone installations)
Use --fix to automatically repair common issues.
memory server doctor [flags]
Options
--debug Show detailed debug information (copyable for bug reports)
--fix Attempt to automatically fix detected issues
-h, --help help for doctor
memory server install
Install Memory standalone server
Synopsis
Install Memory standalone server with all required components.
This command will:
- Check Docker and Docker Compose are installed
- Create installation directory (~/.memory by default)
- Generate secure configuration (API keys, passwords)
- Write Docker Compose configuration
- Pull and start Docker containers
- Configure the CLI to connect to the local server
Example:
memory install
memory install --port 8080 --google-api-key YOUR_KEY
memory install --dir /opt/memory --skip-start
memory server install [flags]
Options
--dir string Installation directory (default "/root/.memory")
--force Overwrite existing installation
--google-api-key string Google API key for embeddings
-h, --help help for install
--port int Server port (default 3002)
--skip-start Generate config but don't start services
memory server uninstall
Remove Memory installation
Synopsis
Remove Memory standalone server installation.
This command will:
- Stop and remove Docker containers
- Remove Docker volumes (unless --keep-data is specified)
- Remove installation directory
Example:
memory uninstall
memory uninstall --keep-data
memory uninstall --force
memory server uninstall [flags]
Options
--dir string Installation directory (default "/root/.memory")
--force Skip confirmation prompt
-h, --help help for uninstall
--keep-data Keep Docker volumes (preserve data)
memory server upgrade
Upgrade the standalone server installation
Synopsis
Upgrades the Memory standalone server installation.
This will:
- Pull the latest Docker images
- Restart services with the new images
- Preserve all existing configuration and data
Examples:
memory server upgrade
memory server upgrade --dir ~/.memory
memory server upgrade [flags]
Options
--dir string Installation directory (default "/root/.memory")
-f, --force Force upgrade without confirmation
-h, --help help for upgrade
memory set-token
Save a static Bearer token as CLI credentials
Synopsis
Save a static Bearer token to ~/.memory/credentials.json.
Useful in CI, test harnesses, and dev environments where a token is
pre-issued rather than obtained via the OAuth device flow.
Example:
memory auth set-token e2e-test-user
memory set-token <bearer-token> [flags]
Options
--duration string Token validity duration (default 24h, e.g. 48h, 168h)
-h, --help help for set-token
memory skills
Manage skills
Synopsis
Commands for managing skills — reusable Markdown workflow instructions for agents
Options
--global Use global scope (built-in skills only, superadmin)
-h, --help help for skills
--json Output as JSON
--org string Organization ID (creates/lists org-scoped skill)
--project string Project ID (creates/lists project-scoped skill)
memory skills create
Create a skill
Synopsis
Create a new skill. Use --project to create a project-scoped skill, or omit for global.
memory skills create [flags]
Options
--content string Skill content (Markdown)
--content-file string Path to a file containing the skill content
--description string Skill description (required)
-h, --help help for create
--name string Skill name (slug, e.g. 'my-skill') (required)
memory skills delete
Delete a skill by ID
Synopsis
Permanently delete a skill by its ID.
Prints "Skill deleted." on success. You will be prompted for confirmation
unless the --confirm flag is provided.
memory skills delete [id] [flags]
Options
--confirm Skip confirmation prompt
-h, --help help for delete
memory skills get
Get a skill by ID
Synopsis
Get full details for a skill by its ID.
Prints ID, Name, Description, Scope (global / org / project), Created and
Updated timestamps, and the full skill Content. Use --json to receive the raw
JSON response instead.
memory skills get [id] [flags]
Options
-h, --help help for get
memory skills import
Import skills from a SKILL.md file or directory
Synopsis
Import one or more skills and register them on the server so agents can use them.
Import a single SKILL.md file:
memory skills import path/to/SKILL.md
Import all skills found in a directory (scans one level deep for SKILL.md files):
memory skills import --from-dir .agents/skills/
Auto-discover skills from well-known locations (.agents/skills/, ~/.claude/skills/, etc.):
memory skills import --discover
Import all discovered skills without prompting:
memory skills import --discover --all
Import built-in Memory skills from the embedded catalog:
memory skills import --builtin
Import built-in skills including experimental ones:
memory skills import --builtin --experimental
memory skills import [path] [flags]
Options
--all Import all found skills without prompting
--builtin Import from the built-in embedded Memory skill catalog
--discover Auto-discover skills from well-known locations (.agents/skills/, ~/.claude/skills/, etc.)
--experimental Include experimental skills when importing from the built-in catalog (--builtin)
--from-dir string Scan a directory for SKILL.md files and import all found skills
-h, --help help for import
memory skills list
List skills installed on the server
Synopsis
List skills stored on the server and available to agents.
Output is a table with columns: NAME, DESCRIPTION (truncated to 55 characters),
SCOPE (global/org/project), and ID. Use --project to include project-scoped
skills, or --global for global-only skills. Use --json to receive the full
skill list as JSON.
memory skills list [flags]
Options
-h, --help help for list
memory skills update
Update a skill
Synopsis
Update the description or content of an existing skill.
Prints "Skill updated." followed by the skill's ID and Name on success. At
least one of --description, --content, or --content-file must be provided.
Use --json to receive the full updated skill as JSON instead.
memory skills update [id] [flags]
Options
--content string New content (Markdown)
--content-file string Path to file with new content
--description string New description
-h, --help help for update
memory status
Show current authentication status
Synopsis
Display detailed information about the current authentication session and server health.
Shows authentication Mode (project token, account API key, or OAuth), Server URL,
masked credential key, and connection Status (Connected or unreachable). Also
displays server Health and Version. If authenticated as a user, prints the active
project Name and ID, or a numbered list of all accessible projects.
Additionally prints full Usage Statistics for the active project including:
Documents, Graph Objects, Relationships, Type Registry (Types, Enabled,
TypesWithObjects), Template Packs, and Processing Pipeline job queue depths.
memory status [flags]
Options
-h, --help help for status
memory tokens
Manage API tokens
Synopsis
Commands for managing API tokens (emt_* keys). Tokens can be account-level (cross-project) or project-scoped.
Options
-h, --help help for tokens
--project string Project name or ID (omit for account-level tokens)
memory tokens create
Create a new API token
Synopsis
Create a new API token.
Without --project, creates an account-level token usable across all projects.
With --project, creates a project-scoped token.
On success, prints the full plaintext Token value prominently (this is the only
time the full token is shown — save it immediately), followed by ID, Name, Type,
Prefix, Scopes, and Created timestamp.
Valid scopes: schema:read, data:read, data:write, agents:read, agents:write, projects:read, projects:write
memory tokens create [flags]
Options
-h, --help help for create
--name string Token name (required)
--scopes string Comma-separated scopes (default: data:read). Valid: schema:read, data:read, data:write, agents:read, agents:write, projects:read, projects:write
memory tokens get
Get token details
Synopsis
Get details for a specific API token by its ID.
Use --project to specify a project-scoped token; without it, looks up an
account-level token.
memory tokens get [token-id] [flags]
Options
-h, --help help for get
memory tokens list
List API tokens
Synopsis
List API tokens and their details.
Without --project, lists account-level tokens. With --project, lists tokens
for the specified project. Each token entry prints: Name, ID, Prefix, Type
(account or project), Scopes, Created timestamp, and Revoked timestamp (if
applicable). For project tokens, the full plaintext token value is also fetched
and displayed — treat this output as sensitive.
memory tokens list [flags]
Options
-h, --help help for list
memory tokens revoke
Revoke an API token
Synopsis
Permanently revoke an API token, making it unusable. Without --project, revokes an account-level token.
memory tokens revoke [token-id] [flags]
Options
-h, --help help for revoke
memory traces
Query traces
Synopsis
Query OpenTelemetry traces via the server's built-in Tempo proxy.
Traces are proxied through the configured --server endpoint so no direct
access to Tempo is required.
Options
-h, --help help for traces
memory traces get
Fetch a full trace by ID
Synopsis
Fetch and display a full trace as an indented span tree.
Prints the Trace ID, then each span in a tree structure showing the span name
