菜单
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.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
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.
Create a versioned release — commit, tag, push, and deploy to servers. Use when the user wants to release, deploy, publish, or push a new version.
Analyze and dump OpenCode sessions from any project. Use when the user asks to read a session, find a session by title, list sessions for a project, dump session content, or show usage stats (skills, tools, tokens, cost) for any project directory.
Read from the knowledge graph — natural language questions, semantic search, or hybrid search over objects and documents.
Create and manage graph branches — isolated workspaces for staging changes before merging to main. Use for what-if analysis, planning, or any work that should not immediately affect the main graph.
Install, list, or remove schemas (object and relationship type definitions) in an existing project. Use after onboarding when managing or updating the type registry.
| 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:
memory agents get-run, memory provider configure-project)Full command reference auto-generated from memory --help. Each section covers one command or subcommand with its synopsis, usage, and flags.
CLI tool for Memory platform
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.
--compact use compact output layout
--config string config file (default is $HOME/.memory/config.yaml)
--debug enable debug logging
-h, --help help for memory
--json shorthand for --output json
--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
Agent Communication Protocol (ACP) operations
Commands for interacting with agents via the Agent Communication Protocol (ACP) v1 API.
-h, --help help for acp
Manage ACP agents
Discover and inspect agents exposed via the Agent Communication Protocol.
-h, --help help for agents
Get an ACP agent manifest
Get the full manifest for a specific ACP agent by its slug name.
Displays the agent's name, description, capabilities, input/output modes, and status metrics. Use --json for the raw JSON response.
memory acp agents get <name> [flags]
-h, --help help for get
List externally-visible ACP agents
List all agents with visibility='external' that are exposed via ACP.
Displays a table with NAME, DESCRIPTION, VERSION, and SUCCESS RATE columns. Use --json to output the raw JSON response.
memory acp agents list [flags]
-h, --help help for list
Check that the ACP endpoint is reachable
Ping the ACP v1 endpoint on the configured Memory server.
This command does not require authentication.
memory acp ping [flags]
-h, --help help for ping
Manage ACP agent runs
Create, inspect, cancel, and resume agent runs via ACP.
-h, --help help for runs
Cancel an ACP run
Cancel a running or queued ACP run.
Requests cancellation of the specified run. The run transitions to 'cancelling' and eventually 'cancelled'.
memory acp runs cancel <agent-name> <run-id> [flags]
-h, --help help for cancel
Create a new ACP agent run
Create a new run for an ACP agent.
Requires --message with the user's input text. The --mode flag controls execution mode: sync (default) — blocks until the run completes, prints output async — returns immediately with the run ID and status stream — streams the agent's output to stdout in real-time
If a sync run pauses for human input (status: input-required), the CLI will prompt you interactively and automatically resume the run.
Use --session to link the run to an existing ACP session.
memory acp runs create <agent-name> [flags]
-h, --help help for create
--message string Input message for the agent (required)
--mode string Execution mode: sync, async, stream (default "sync")
--session string Link run to an existing ACP session ID
Get an ACP run by ID
Get the state of a specific ACP run.
Displays run status, output messages, and timing. If the run is paused (input-required), shows the pending question. Use --json for raw JSON output.
memory acp runs get <agent-name> <run-id> [flags]
-h, --help help for get
Resume a paused ACP run
Resume an ACP run that is waiting for human input (status: input-required).
Requires --message with the response to the agent's question. Use --mode to control execution mode (sync, async, stream).
memory acp runs resume <agent-name> <run-id> [flags]
-h, --help help for resume
--message string Response message (required)
--mode string Execution mode: sync, async, stream (default "sync")
Manage ACP sessions
Create and inspect ACP sessions for grouping related agent runs.
-h, --help help for sessions
Create a new ACP session
Create a new ACP session.
Sessions group related agent runs together. Use --agent to scope the session to a specific agent.
memory acp sessions create [flags]
--agent string Scope session to a specific agent
-h, --help help for create
Get an ACP session
Get details of an ACP session including its run history.
Use --json for raw JSON output.
memory acp sessions get <session-id> [flags]
-h, --help help for get
Manage and inspect ADK sessions
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.
-h, --help help for adk-sessions
--project string Project name or ID
Get details and event history for a specific ADK session
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]
-h, --help help for get
List ADK sessions for the active project
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]
-h, --help help for list
Manage agent definitions
Commands for managing agent definitions (system prompts, tools, model config, flow type, visibility)
-h, --help help for agent-definitions
Create a new agent definition
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]
--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)
--skills string Comma-separated skill names (e.g. "code-review,*")
--system-prompt string System prompt
--tools string Comma-separated tool names
--visibility string Visibility (external, project, internal)
Delete an agent definition
Delete an agent definition by ID
memory agent-definitions delete [id] [flags]
-h, --help help for delete
Get agent definition details
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]
-h, --help help for get
--json Output as JSON
List all agent definitions
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]
-h, --help help for list
--json Output as JSON
--limit int Maximum number of definitions to show (0 = all)
--page int Page number (1-based, used with --limit) (default 1)
View or set per-project agent overrides
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]
--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)
List all agent overrides for the project
List all per-project agent configuration overrides.
memory agent-definitions overrides [flags]
-h, --help help for overrides
Update an agent definition
Update an existing agent definition (partial update)
memory agent-definitions update [id] [flags]
--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
--skills string New comma-separated skill names
--system-prompt string New system prompt
--tools string New comma-separated tool names
--visibility string New visibility
Manage runtime agents
Commands for managing runtime agents (scheduling, triggers, execution state)
-h, --help help for agents
--project string Project name or ID (auto-detected from config/env if not specified)
Manage built-in tools
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.
-h, --help help for builtin-tools
Set runtime config for a built-in tool
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]
-h, --help help for configure
List all built-in tools
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]
-h, --help help for list
--limit int Maximum number of tools to show (0 = all)
--page int Page number (1-based, used with --limit) (default 1)
Enable or disable a built-in tool
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]
-h, --help help for toggle
Create a new agent
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]
--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)
Delete an agent
Delete an agent by ID.
Prints "Agent deleted successfully." on success.
memory agents delete [id] [flags]
-h, --help help for delete
Get details for a specific run
Get full details for a specific agent run by its run ID. Output includes:
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]
-h, --help help for get-run
--json Output result as JSON
Get agent details
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]
-h, --help help for get
--json Output as JSON
Manage agent webhook hooks
Commands for managing webhook hooks on agents (create, list, delete)
-h, --help help for hooks
Create a webhook hook
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]
--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)
Delete a webhook hook
Delete a webhook hook from an agent
memory agents hooks delete [agent-id] [hook-id] [flags]
-h, --help help for delete
List webhook hooks
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]
-h, --help help for list
List all agents
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]
-h, --help help for list
--json Output as JSON
--limit int Maximum number of agents to show (0 = all)
--page int Page number (1-based, used with --limit) (default 1)
Manage MCP servers
Commands for managing Model Context Protocol (MCP) servers in the Memory platform
-h, --help help for mcp-servers
Configure a tool's runtime settings
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]
-h, --help help for configure
Create a new MCP server
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]
--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)
Delete an MCP server
Remove an MCP server and all its tools from your project configuration
memory agents mcp-servers delete [server-id] [flags]
-h, --help help for delete
Get MCP server details
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]
-h, --help help for get
Inspect an MCP server
Test connection to an MCP server and display its capabilities, tools, prompts, and resources
memory agents mcp-servers inspect [server-id] [flags]
-h, --help help for inspect
List all MCP servers
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]
-h, --help help for list
Sync tools from an MCP server
Connect to the MCP server and refresh the list of available tools
memory agents mcp-servers sync [server-id] [flags]
-h, --help help for sync
List tools for an MCP server
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]
-h, --help help for tools
Manage agent questions
Commands for listing and responding to agent questions
-h, --help help for questions
List questions for a project
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]
-h, --help help for list-project
--status string Filter by status (pending, answered, cancelled, expired)
List questions for a run
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]
-h, --help help for list
Respond to a question
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]
-h, --help help for respond
List agent runs
List recent runs for an agent. Each run entry shows:
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]
-h, --help help for runs
--json Output as JSON
--limit int Maximum number of runs to return (default 10)
Trigger an agent run
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]
--env stringArray Environment variable to inject into sandbox (KEY=VALUE, repeatable)
-h, --help help for trigger
--input string Initial message to pass to the agent at trigger time
--model string Override the model for this single run (e.g. claude-sonnet-4.7)
Update an agent
Update an existing agent (partial update)
memory agents update [id] [flags]
--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
Ask the Memory CLI assistant a question or request a task
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.).
Words after "ask" are joined into the question — quotes are optional.
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]
-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)
Install or export Blueprints (schemas, agents, skills, seed data)
Blueprints are structured directories (or GitHub repos) containing schemas, agent definitions, skills, and seed data to apply to a project.
Subcommands:
memory blueprints install
Examples:
memory blueprints install ./my-config memory blueprints install https://github.com/acme/memory-blueprints memory blueprints install https://github.com/acme/memory-blueprints#v1.2.0 --upgrade memory blueprints inspect https://github.com/acme/memory-blueprints memory blueprints install ./my-config --dry-run memory blueprints dump ./exported
memory blueprints [flags]
--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
Export project graph objects and relationships as JSONL seed files
Export the current project's graph objects and relationships as per-type JSONL seed files that can be re-applied with "memory blueprints install
".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]
-h, --help help for dump
--types string Comma-separated list of object/relationship types to export (default: all types)
List the contents of a Blueprint directory or GitHub URL
Inspect a Blueprint directory (or GitHub repository) and display a detailed listing of its contents without making any API calls or modifying the project.
Shows all discovered packs (with object and relationship type listings), agents, skills, and seed data counts. Useful for reviewing what a blueprint contains before installing it.
Examples:
memory blueprints inspect ./my-config memory blueprints inspect https://github.com/acme/memory-blueprints memory blueprints inspect https://github.com/acme/memory-blueprints#v1.2.0
memory blueprints inspect <source> [flags]
-h, --help help for inspect
--token string GitHub personal access token (for private repos); also read from MEMORY_GITHUB_TOKEN
Apply Blueprints from a directory or GitHub URL
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: schemas/ — 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.
Examples:
memory blueprints install ./my-config memory blueprints install https://github.com/acme/memory-blueprints memory blueprints install https://github.com/acme/memory-blueprints#v1.2.0 --upgrade memory blueprints install ./my-config --dry-run
memory blueprints install <source> [flags]
--dry-run Preview actions without making any API calls
-h, --help help for install
--token string GitHub personal access token (for private repos); also read from MEMORY_GITHUB_TOKEN
--upgrade Update existing resources instead of skipping them
Validate a Blueprint directory or GitHub URL without applying it
Validate a Blueprint directory (or GitHub repository) without making any API calls or modifying the project.
Checks performed: Packs — required fields, object/relationship type definitions, internal cross-references (sourceType/targetType must name an objectType in the same pack), duplicate names within and across files. Agents — required fields, enum values (flowType, visibility, dispatchMode), model.name required when model block is present, duplicate names. Skills — required fields, non-empty content body, duplicate names. Seed data — required fields, key presence (warning when missing), type cross-referenced against loaded pack definitions, srcKey/dstKey cross-referenced against seed object keys.
Exits 0 when only warnings are found, exits 1 when any error is found.
Examples:
memory blueprints validate ./my-config memory blueprints validate https://github.com/acme/memory-blueprints memory blueprints validate https://github.com/acme/memory-blueprints#v1.2.0
memory blueprints validate <source> [flags]
-h, --help help for validate
--token string GitHub personal access token (for private repos); also read from MEMORY_GITHUB_TOKEN
Interactive TUI for browsing projects and documents
Launch an interactive terminal UI (TUI) for browsing projects, documents, and extractions.
The TUI provides:
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]
-h, --help help for browse
--tempo-url string Override Tempo URL (auto-derived from server URL by default)
Show what's new since your current version
Display the aggregated changelog between your installed version and the latest release.
For dev builds, shows the latest release changelog only. If you are already on the latest version, a message is shown instead.
memory changelog [flags]
-h, --help help for changelog
Generate shell completion scripts
Generate shell completion scripts for Memory CLI.
The completion script provides:
To load completions:
Bash: $ source <(memory completion bash)
$ memory completion bash > /etc/bash_completion.d/memory
$ memory completion bash > $(brew --prefix)/etc/bash_completion.d/memory
Zsh:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
$ memory completion zsh > "${fpath[1]}/_memory"
Fish: $ memory completion fish | source
$ memory completion fish > ~/.config/fish/completions/memory.fish
PowerShell: PS> memory completion powershell | Out-String | Invoke-Expression
PS> memory completion powershell > memory.ps1
Notes:
memory completion [bash|zsh|fish|powershell]
-h, --help help for completion
Manage CLI configuration
Configure server URL, credentials, and other settings for the Memory CLI
-h, --help help for config
Set the email for authentication
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]
--config string config file path
-h, --help help for set-credentials
Set the Memory server URL
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]
--config string config file path
-h, --help help for set-server
Set a configuration value
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 auto_update_enabled Enable/disable automatic update checks (true/false) auto_update_mode Update mode: notify (default) or auto auto_update_check_interval How often to check for updates (e.g., 24h, 12h) google_api_key Google AI API key (for LLM features) openai_base_url OpenAI-compatible base URL (e.g., http://localhost:11434/v1) openai_api_key OpenAI-compatible API key (optional for local servers) llm_model LLM model name (e.g., llama3, mistral)
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]
--config string config file path
-h, --help help for set
Display current configuration
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]
--config string config file path
-h, --help help for show
Manage project documents
Commands for managing documents in the Memory platform
-h, --help help for documents
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
Delete a document
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]
-h, --help help for delete
Show extraction summary for a document
Show the extraction summary for the most recently completed extraction job on a document.
Displays counts of objects created (broken down by type), relationships created, chunks processed, and the completion timestamp. Use --output json for a machine-readable response.
memory documents extraction-summary <id> [flags]
-h, --help help for extraction-summary
Get a document by ID
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]
-h, --help help for get
List documents
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]
-h, --help help for list
--limit int Maximum number of results (default 50)
Upload a file as a document
Upload a local file and create a document record. Use --auto-extract to trigger extraction after upload.
memory documents upload <file> [flags]
--auto-extract Trigger extraction after upload
-h, --help help for upload
Manage embedding workers
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
--config-path string path to Memory config.yaml
-h, --help help for embeddings
--server string Memory server URL (overrides config)
Delete all pending and processing embedding jobs from both queues
Delete all pending and processing jobs from the object and relationship embedding queues. Useful when the queue is stuck or polluted.
Examples: memory embeddings clear memory embeddings clear --server http://your-server:3002
memory embeddings clear [flags]
-h, --help help for clear
Get or set embedding worker config (batch, concurrency, stale-minutes)
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]
--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)
Pause all embedding workers (object, relationship, sweep)
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]
-h, --help help for pause
Show embedding job queue progress (pending, processing, completed, failed)
Show embedding job queue statistics for all queues.
Displays counts of pending, processing, completed, failed, and dead-letter jobs for both the graph object and graph relationship embedding queues.
Examples: memory embeddings progress memory embeddings progress --server http://your-server:3002
memory embeddings progress [flags]
-h, --help help for progress
Resume all embedding workers
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]
-h, --help help for resume
Show pause/run state of all embedding workers
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]
-h, --help help for status
Manage extraction operations
Commands for managing extraction jobs and related operations in the Memory platform
-h, --help help for extraction
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
Manage extraction jobs
Create, monitor, and manage extraction jobs that extract structured entities from documents
-h, --help help for jobs
Cancel an extraction job
Cancel a running or queued extraction job.
Completed or failed jobs cannot be cancelled.
Requires an API key with admin:write scope.
memory extraction jobs cancel <job-id> [flags]
-h, --help help for cancel
Create a new extraction job
Create a new extraction job for a document.
Requires --project and --document flags. The extraction job will process the document and extract structured entities based on any installed schemas.
Requires an API key with admin:write scope.
memory extraction jobs create [flags]
--document string Document ID to extract from (required)
-h, --help help for create
Get extraction job details
Get detailed information about an extraction job by its ID.
Shows the job status, progress, created/updated timestamps, and any error messages.
Requires an API key with admin:read scope.
memory extraction jobs get <job-id> [flags]
-h, --help help for get
--interval duration Poll interval (minimum 1s) (default 3s)
--quiet Suppress progress updates
--timeout duration Maximum watch duration (default 10m0s)
--watch Poll until terminal state (completed/failed/cancelled)
List extraction jobs
List extraction jobs for a project.
Use --status to filter by job status (queued, running, completed, failed, cancelled). Use --document to filter by source document ID. Use --limit to control the number of results (default 50).
Requires an API key with admin:read scope.
memory extraction jobs list [flags]
--document string Filter by document ID
-h, --help help for list
--limit int Maximum number of results (default 50)
--status string Filter by status (queued, running, completed, failed, cancelled)
Get logs for an extraction job
Get execution logs for an extraction job.
Shows processing steps, entity discoveries, and any errors encountered during extraction.
Requires an API key with admin:read scope.
memory extraction jobs logs <job-id> [flags]
-h, --help help for logs
Retry a failed extraction job
Retry a failed extraction job.
The job will be re-queued for processing with the same configuration.
Requires an API key with admin:write scope.
memory extraction jobs retry <job-id> [flags]
-h, --help help for retry
Get extraction job statistics for a project
Get aggregated statistics for extraction jobs in a project.
Shows counts by status (queued, running, completed, failed, cancelled) and other metrics.
Requires an API key with admin:read scope.
memory extraction jobs stats [flags]
-h, --help help for stats
Soft-delete knowledge graph objects matching a natural-language query
Find and soft-delete graph objects that match a natural-language query.
Deletes are REVERSIBLE — use 'memory graph restore ' to undo any deletion.
Strategy controls confirmation behaviour: confirm Ask for approval before executing a batch of deletes (default) auto Delete automatically without asking ask Require per-delete confirmation (interactive terminals only)
Cascade depth controls how many hops of neighbors are also deleted: 1 Direct matches only 2 Direct matches + 1-hop neighbors (default) 3 Direct matches + 2-hop neighbors
Examples: memory forget "all auth related nodes" memory forget --strategy auto "temporary test objects" memory forget --cascade 1 "the node named foo" memory forget --dry-run "everything tagged deprecated" memory forget --project abc123 "old migration objects"
memory forget [text] [flags]
--cascade int Cascade depth: 1 (direct only), 2 (1-hop), 3 (2-hop) (default 2)
--dry-run Report what would be deleted without performing any deletes
-h, --help help for forget
--json Output results as JSON
--project string Project ID (uses default project if not specified)
--session string Continue a previous forget session
--show-time Show elapsed time
--show-tools Show tool calls made by the agent
--strategy string Deletion strategy: auto, confirm, ask (default "confirm")
Manage graph objects and relationships
Commands for managing graph objects and relationships in the Memory knowledge graph
-h, --help help for graph
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
Manage graph branches
Manage isolated workspaces (branches) for the knowledge graph.
A branch is a copy of the graph where you can create, update, and delete objects and relationships without affecting the main graph. Changes stay isolated until you explicitly merge them.
The main graph has no branch ID. All graph write commands (objects create, relationships create, etc.) accept --branch to target a branch instead of the main graph. Without --branch, writes go to the main graph.
Typical workflow:
-h, --help help for branches
Create a new branch
Create a new branch — an isolated workspace for the knowledge graph.
Objects and relationships written with --branch are visible only on that branch until merged. The main graph is unaffected until you run "memory graph branches merge".
--parent is optional metadata recording which branch this was forked from. It does not affect merge behavior — it is lineage information only.
After creating a branch, capture its ID immediately:
BRANCH_ID=$(memory graph branches create --name "my-branch" --output json
| python3 -c "import json,sys; print(json.load(sys.stdin)['id'])")
Then use it on all graph writes:
memory graph objects create --type Service --key "svc-x" --branch "$BRANCH_ID" memory graph relationships create --type depends_on --from --to --branch "$BRANCH_ID"
Examples: memory graph branches create --name "scenario/what-if" memory graph branches create --name "feature-x" --project memory graph branches create --name "child" --parent
memory graph branches create [flags]
--description string Branch description (optional)
-h, --help help for create
--name string Branch name (required)
--parent string Parent branch ID
Delete a branch
Delete a branch and all objects that exist only on that branch.
Objects that have already been merged into another branch are unaffected. This operation is irreversible.
Examples: memory graph branches delete
memory graph branches delete <id> [flags]
-h, --help help for delete
Fork a branch with object copies
Fork a branch — create a new branch and copy all HEAD objects and relationships from the source into it.
SOURCE: use a branch UUID from "memory graph branches list", or the special keyword "main" to fork from the main graph (branch_id IS NULL).
Copied objects preserve their canonical IDs so a subsequent merge back into the source is aware of shared identity. Only HEAD versions are copied (not full version history).
Use --filter-type to selectively copy only certain object types. When a filter is applied, relationships where one endpoint was excluded are silently skipped (the response reports the skipped count).
Examples: memory graph branches fork main --name "what-if-scenario" memory graph branches fork main --name "subset" --filter-type Service --filter-type API memory graph branches fork --name "child" --description "child branch"
memory graph branches fork <source-branch-id|main> [flags]
--description string Branch description (optional)
--filter-type strings Only copy objects of these types (repeatable)
-h, --help help for fork
--name string New branch name (required)
Get a branch by ID
Get details for a branch by its ID.
Use --output json to receive the full object as JSON.
Examples: memory graph branches get memory graph branches get --output json
memory graph branches get <id> [flags]
-h, --help help for get
List graph branches
List all branches for the current project.
The main graph is not a branch and does not appear in this list. Every branch shown here has an ID you can pass to --branch on graph write commands, or as the target/source of a merge.
Use --output json to get full branch details including parent_branch_id and created_at, which is useful for scripting.
Examples: memory graph branches list memory graph branches list --project memory graph branches list --output json
memory graph branches list [flags]
-h, --help help for list
Merge a source branch into a target branch (or main)
Merge changes from a source branch into a target branch.
DIRECTION: source → target. The source branch is read; the target branch receives the changes.
TARGET: use a branch UUID from "memory graph branches list", or the special keyword "main" to merge into the main graph (branch_id IS NULL).
By default this is a DRY RUN — no changes are made. Pass --execute only when you are ready to apply.
MERGE CLASSIFICATIONS: added — object exists on source only; will be created on target fast_forward — object changed on source only; target will be updated conflict — object changed on BOTH branches; merge is BLOCKED unchanged — identical on both branches; nothing to do
If any conflicts exist, --execute is blocked. Resolve conflicts manually (update the source or target so they agree) then re-run.
The merge runs in a single database transaction — all-or-nothing.
WORKFLOW:
memory graph branches merge main --source
memory graph branches merge main --source --output json
memory graph branches merge main --source --execute
Examples: memory graph branches merge main --source memory graph branches merge main --source --execute memory graph branches merge --source --execute memory graph branches merge --source --output json
memory graph branches merge <target-branch-id|main> [flags]
--execute Execute the merge (default is dry run)
-h, --help help for merge
--source string Source branch ID to merge from (required)
Update a branch
Update a branch's name or description.
Use --name to rename the branch. Use --description to set or update the description. At least one flag is required.
Examples: memory graph branches update --name "new-name" memory graph branches update --description "staging area for Q4 planning" memory graph branches update --name "new-name" --description "updated purpose"
memory graph branches update <id> [flags]
--description string New branch description
-h, --help help for update
--name string New branch name
Stream real-time graph object events via SSE
Opens a Server-Sent Events stream and prints graph object create/update/delete events as they occur.
memory graph events [flags]
-h, --help help for events
Explore the knowledge graph visually in the browser
Start a local web server and open an interactive graph visualizer in your browser.
The visualizer lets you search for nodes, click to expand neighbors, and follow paths through the knowledge graph. All API calls are proxied through the CLI process — no credentials are ever sent to the browser.
Examples: memory graph explore memory graph explore --port 7734 memory graph explore --host 0.0.0.0 --port 7734 memory graph explore --project my-project memory graph explore --branch my-feature-branch
memory graph explore [flags]
--branch string Branch name or ID to explore (default: main graph)
-h, --help help for explore
--host string Host/IP to bind (use 0.0.0.0 to listen on all interfaces) (default "127.0.0.1")
--port int Local port to listen on (default 7734)
--project string Project ID (overrides config/env)
Manage graph objects
-h, --help help for objects
Bulk delete graph objects matching a filter
Permanently delete all graph objects matching the given filter.
This is a shorthand for bulk-update --action hard_delete. Use --dry-run to preview the number of matching objects without deleting any.
Examples: memory graph objects bulk-delete --type Message --dry-run memory graph objects bulk-delete --type Log --filter "created_at=90d" --filter-op lt --limit 5000
memory graph objects bulk-delete [flags]
--dry-run Preview matched count without deleting
--filter stringArray Property filter key=value (repeatable)
--filter-op string Operator for --filter: eq, neq, gt, gte, lt, lte, contains, in, exists (default "eq")
-h, --help help for bulk-delete
--limit int Maximum number of objects to delete (default 1000, max 100000; 0 = server default)
--type string Filter by object type (comma-separated)
Bulk update graph objects matching a filter
Execute a bulk action on all graph objects matching the given filter.
The --action flag controls what operation is performed. Use --dry-run to preview the number of matching objects without making any changes.
Supported actions: update_status Set status field (requires --value) soft_delete Set deleted_at timestamp hard_delete Permanently remove objects merge_properties Deep-merge --properties into existing JSONB properties replace_properties Replace the entire properties object add_labels Add labels (--labels) remove_labels Remove labels (--labels) set_labels Replace all labels (--labels)
Examples: memory graph objects bulk-update --type Message --action update_status --value archived memory graph objects bulk-update --type Document --filter "days_since_access>365" --action soft_delete --dry-run memory graph objects bulk-update --action merge_properties --properties '{"verified":true}' --limit 500
memory graph objects bulk-update [flags]
--action string Action to perform: update_status, soft_delete, hard_delete, merge_properties, replace_properties, add_labels, remove_labels, set_labels (required)
--dry-run Preview matched count without making changes
--filter stringArray Property filter key=value (repeatable)
--filter-op string Operator for --filter: eq, neq, gt, gte, lt, lte, contains, in, exists (default "eq")
-h, --help help for bulk-update
--labels stringArray Labels for add_labels/remove_labels/set_labels actions
--limit int Maximum number of objects to affect (default 1000, max 100000; 0 = server default)
--properties string JSON properties for merge_properties/replace_properties actions
--type string Filter by object type (comma-separated)
--value string Value for update_status action
Batch-create graph objects (and optionally relationships) from a JSON file
Create multiple graph objects in one API call. Accepts two input formats:
FLAT ARRAY FORMAT (objects only): 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: [ {"type": "Person", "name": "Alice"}, {"type": "Project", "name": "Acme", "properties": {"status": "active"}} ]
Output: one line per object:
SUBGRAPH FORMAT (objects + relationships, preferred when wiring is needed): A JSON object with "objects" and "relationships" arrays. Objects carry an optional "_ref" placeholder; relationships reference objects via "src_ref"/"dst_ref" for new objects in the same call, or "src_id"/"dst_id" for pre-existing UUIDs. Both can be mixed freely. Max 500 objects, 500 relationships per call — larger inputs are auto-chunked with a warning.
Example (new objects only): { "objects": [ {"_ref": "alice", "type": "Person", "key": "person-alice", "name": "Alice"}, {"_ref": "acme", "type": "Project", "key": "proj-acme", "name": "Acme"} ], "relationships": [ {"type": "member_of", "src_ref": "alice", "dst_ref": "acme"} ] }
Example (mixed: new objects wired to existing UUIDs): { "objects": [ {"_ref": "svc", "type": "Service", "name": "auth-service"} ], "relationships": [ {"type": "calls_service", "src_id": "", "dst_ref": "svc"} ] }
Output (text): one line per object, then "Created N objects, M relationships" Output (--output json): full response including ref_map (placeholder → UUID)
memory graph objects create-batch [flags]
--file string Path to JSON file containing array of objects (required)
-h, --help help for create-batch
Create a graph object
Create a new graph object with the given type and optional properties.
When --key is given, the object is keyed for idempotent operations:
memory graph objects create [flags]
--branch string Branch ID to create the object on (omit for main branch)
--description string Shorthand for --properties '{"description": "..."}' (subject to schema validation)
-h, --help help for create
--key string Stable key for idempotent operations
--name string Shorthand for --properties '{"name": "..."}' (subject to schema validation)
--properties string JSON properties object
--status string Object status (e.g. active, planned, deprecated)
--type string Object type (required)
--upsert Update existing object if key already exists (requires --key)
Delete a graph object
Soft-delete a graph object by ID
memory graph objects delete <id> [flags]
--branch string Branch name or ID to scope deletion to (omit for main branch)
-f, --force Skip confirmation prompt (accepted for scripting compatibility)
-h, --help help for delete
Show edges (relationships) for an object
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]
-h, --help help for edges
Get a graph object by ID or key
Get details for a graph object (entity) by its ID or key.
When a UUID is provided it is fetched directly. When a non-UUID string is provided it is treated as a key and resolved against the specified branch (or the main branch when --branch is omitted).
Use --branch to scope key resolution to a specific branch — accepts either a branch UUID or a human-readable branch name.
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.
Examples: memory graph objects get memory graph objects get my-object-key memory graph objects get my-object-key --branch plan/next-gen memory graph objects get my-object-key --branch
memory graph objects get <id|key> [flags]
--branch string Branch ID or name to resolve the key against (omit for main branch)
-h, --help help for get
--output string Output format: table or json (default "table")
List graph objects
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.
Use --key to filter by the object's stable key field directly. This is the most efficient way to look up a single object by key without fetching all objects.
Use --filter key=value to filter by object properties (repeatable). All filters are combined with AND. The --filter-op flag sets the comparison operator for every --filter in the same invocation (default: eq).
--filter-op operators: eq, neq, gt, gte, lt, lte, contains, in, exists
Examples: memory graph objects list --key sq-soft-delete-employee memory graph objects list --branch --key ep-employees-delete memory graph objects list --filter status=active memory graph objects list --type Feature --filter status=active --filter inertia_tier=1 memory graph objects list --filter status=active,draft --filter-op in memory graph objects list --filter status --filter-op exists
memory graph objects list [flags]
--branch string Branch ID to scope results to (omit for main branch)
--cursor string Pagination cursor from a previous response (next_cursor field)
--filter stringArray Property filter as key=value (repeatable); see --filter-op
--filter-op string Operator for --filter: eq, neq, gt, gte, lt, lte, contains, in, exists (default "eq")
-h, --help help for list
--ids string Fetch specific objects by ID (comma-separated: --ids id1,id2,id3)
--key string Filter by object key (direct key-based lookup)
--limit int Maximum number of results (server default: 1000) (default 1000)
--status string Filter by object status
--type string Filter by object type
Move a graph object to a different branch
Move a graph object from its current branch to a target branch.
The object's full version chain and any self-referencing relationships are moved. If the object has relationships connecting to other objects that are not being moved, the operation fails — move related objects first or delete the relationships.
Use --target-branch to specify the destination branch UUID. Use "main" or omit the flag to move to the main branch.
Examples: memory graph objects move --target-branch memory graph objects move --target-branch main
memory graph objects move <id> [flags]
-h, --help help for move
--output string Output format: table or json (default "table")
--target-branch string Target branch UUID (use 'main' or omit for main branch)
Find objects similar to a given object by embedding
Find graph objects similar to the given object using cosine similarity on stored embeddings.
Returns a ranked list with similarity scores. Use --limit to control result count, --type to filter by object type, and --min-score to exclude low-confidence results. Use --output json to receive the full response as JSON.
Examples: memory graph objects similar memory graph objects similar --limit 20 --type Feature memory graph objects similar --min-score 0.75 --output json
memory graph objects similar <id> [flags]
-h, --help help for similar
--limit int Maximum number of similar objects to return (default 10)
--min-score float Minimum similarity score (0–1); 0 means no threshold
--output string Output format: table or json (default "table")
--type string Filter results by object type
Batch-update graph objects from a JSON file
Update multiple graph objects in one API call.
The input file must contain a JSON array of objects, each with: id (string, required) — object entity ID to update key (string, optional) properties (object, optional) — merged with existing properties labels ([]string, optional) — appended (or replaced with replaceLabels) replaceLabels (bool, optional) — replace labels instead of appending status (string, optional) branch_id (string, optional)
Example updates.json: [ {"id": "", "properties": {"priority": "high"}}, {"id": "", "status": "archived", "labels": ["deprecated"]} ]
Output (one line per object):
memory graph objects update-batch [flags]
--file string Path to JSON file containing array of object updates (required)
-h, --help help for update-batch
--output string Output format: table or json (default "table")
Update a graph object
Update a graph object's properties or status (creates a new version)
memory graph objects update <id> [flags]
--branch string Branch ID to update the object on (omit for main branch)
--description string Shorthand for --properties '{"description": "..."}' (subject to schema validation)
-h, --help help for update
--key string Set a stable key on the object (enables cross-session src_key/dst_key references)
--name string Shorthand for --properties '{"name": "..."}' (subject to schema validation)
--properties string JSON properties object to merge
--status string Set object status (e.g. active, planned, deprecated)
Manage graph relationships
-h, --help help for relationships
Batch-create graph relationships from a JSON file
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)
Use --upsert to make the operation idempotent: existing relationships (same type, from, to) are returned as-is instead of causing an error. Safe to retry.
Example relationships.json: [ {"type": "knows", "from": "", "to": ""}, {"type": "manages", "from": "", "to": ""} ]
Output (one line per relationship): ->
memory graph relationships create-batch [flags]
--file string Path to JSON file containing array of relationships (required)
-h, --help help for create-batch
--upsert Apply upsert semantics to all items: skip existing relationships instead of failing
Create a relationship
Create a directed relationship between two graph objects.
When --upsert is given, the operation is idempotent: if a relationship with the same type, source, and destination already exists, it is returned as-is without creating a duplicate. If the relationship was deleted, it is restored. Without --upsert, creating a relationship that already exists returns an error.
memory graph relationships create [flags]
--branch string Branch ID to create the relationship on (omit for main branch)
--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)
--upsert Return existing relationship if (type, from, to) already exists instead of creating a duplicate
Delete a relationship
Soft-delete a graph relationship by ID.
Use --branch to scope the deletion to a specific branch (name or UUID). Without --branch the relationship is deleted from the main graph.
Examples: memory graph relationships delete memory graph relationships delete --branch plan/next-gen memory graph relationships delete --branch
memory graph relationships delete <id> [flags]
--branch string Branch name or ID to scope deletion to (omit for main branch)
-h, --help help for delete
Get a relationship by ID
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]
-h, --help help for get
List relationships
List relationships in the current project.
Output is a table with columns: Entity ID, Type, From (source entity ID), To