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.
Installation
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
This SKILL.md is very large, so SkillsMP previews the first section here.View on GitHub
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.
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
--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
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)
--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)
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
--limit int Maximum number of definitions to show (0 = all)
--page int Page number (1-based, used with --limit) (default 1)
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.
--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
--skills string New comma-separated skill names
--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.
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
--limit int Maximum number of tools to show (0 = all)
--page int Page number (1-based, used with --limit) (default 1)
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
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.
--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)
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
--limit int Maximum number of agents to show (0 = all)
--page int Page number (1-based, used with --limit) (default 1)
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.
--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
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
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
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.
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.).
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]
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
Install or export Blueprints (schemas, agents, skills, seed data)
Synopsis
Blueprints are structured directories (or GitHub repos) containing schemas,
agent definitions, skills, and seed data to apply to a project.
Subcommands:
memory blueprints install Apply blueprints from a directory or GitHub URL
memory blueprints inspect List contents of a blueprint without installing
memory blueprints validate Validate a blueprint offline (no API calls)
memory blueprints dump Export project graph data as JSONL seed files
--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 install
-h, --help help for dump
--types string Comma-separated list of object/relationship types to export (default: all types)
memory blueprints inspect
List the contents of a Blueprint directory or GitHub URL
Synopsis
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.
-h, --help help for inspect
--token string GitHub personal access token (for private repos); also read from MEMORY_GITHUB_TOKEN
memory blueprints install
Apply Blueprints 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:
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.
--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
memory blueprints validate
Validate a Blueprint directory or GitHub URL without applying it
Synopsis
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.
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 changelog
Show what's new since your current version
Synopsis
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]
Options
-h, --help help for changelog
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)
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
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 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 extraction-summary
Show extraction summary for a document
Synopsis
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]
Options
-h, --help help for extraction-summary
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 extraction
Manage extraction operations
Synopsis
Commands for managing extraction jobs and related operations in the Memory platform
Options
-h, --help help for extraction
--output string Output format: table or json (default "table")
--project string Project ID (overrides config/env)
memory extraction jobs
Manage extraction jobs
Synopsis
Create, monitor, and manage extraction jobs that extract structured entities from documents
Options
-h, --help help for jobs
memory extraction jobs cancel
Cancel an extraction job
Synopsis
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]
Options
-h, --help help for cancel
memory extraction jobs create
Create a new extraction job
Synopsis
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]
Options
--document string Document ID to extract from (required)
-h, --help help for create
memory extraction jobs get
Get extraction job details
Synopsis
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]
Options
-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)
memory extraction jobs list
List extraction jobs
Synopsis
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]
Options
--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)
memory extraction jobs logs
Get logs for an extraction job
Synopsis
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]
Options
-h, --help help for logs
memory extraction jobs retry
Retry a failed extraction job
Synopsis
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]
Options
-h, --help help for retry
memory extraction jobs stats
Get extraction job statistics for a project
Synopsis
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]
Options
-h, --help help for stats
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 branches
Manage graph branches
Synopsis
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:
Create a branch
Write objects/relationships with --branch
Preview the merge (dry run)
Execute the merge into a target branch
Delete the branch
Options
-h, --help help for branches
memory graph branches create
Create a new branch
Synopsis
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:
--description string Branch description (optional)
-h, --help help for create
--name string Branch name (required)
--parent string Parent branch ID
memory graph branches delete
Delete a branch
Synopsis
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]
Options
-h, --help help for delete
memory graph branches get
Get a branch by ID
Synopsis
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]
Options
-h, --help help for get
memory graph branches list
List graph branches
Synopsis
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]
Options
-h, --help help for list
memory graph branches merge
Merge a source branch into a target branch (or main)
Synopsis
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:
1. Dry run first โ always
memory graph branches merge main --source
2. Inspect conflicts in detail
memory graph branches merge main --source --output json
3. Execute when clean
memory graph branches merge main --source --execute
--description string New branch description
-h, --help help for update
--name string New branch name
memory graph objects
Manage graph objects
Options
-h, --help help for objects
memory graph objects create-batch
Batch-create graph objects (and optionally relationships) from a JSON file
Synopsis
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
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 (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]
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.
When --key is given, the object is keyed for idempotent operations:
By default (skip): if an object with that key already exists, the command
exits successfully without modifying it.
With --upsert: if an object with that key already exists, it is updated
(create-or-update semantics matching blueprint behavior).
memory graph objects create [flags]
Options
--branch string Branch ID to create the object on (omit for main branch)
--description string Set properties.description
-h, --help help for create
--key string Stable key for idempotent operations
--name string Set properties.name
--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)
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.
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).
Examples:
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]
Options
--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
--limit int Maximum number of results (server default: 1000) (default 1000)
--status string Filter by object status
--type string Filter by object type
memory graph objects similar
Find objects similar to a given object by embedding
Synopsis
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]
Options
-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
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
--key string Set a stable key on the object (enables cross-session src_key/dst_key references)
--properties string JSON properties object to merge
--status string Set object status (e.g. active, planned, deprecated)
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)
--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
--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)
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
--branch string Branch ID to scope results to (omit for main branch)
--from string Filter by source object ID
-h, --help help for list
--limit int Maximum number of results (server default: 1000) (default 1000)
--to string Filter by destination object ID
--type string Filter by relationship type
memory journal
Query and annotate the project journal
Synopsis
The project journal is an automatic, server-side activity log for the knowledge graph.
Every mutation (object created/updated/deleted, relationships batched, branches merged)
is logged automatically. You can also add manual markdown notes, standalone or attached
to a specific entry.
Options
-h, --help help for journal
--output string output format (table, json) (default "table")
--project string Project ID (overrides config/env)
memory journal list
List recent journal entries
Synopsis
List recent activity from the project journal, including automatic mutation events
and manual notes. Defaults to the last 7 days.
Usage
memory journal list [flags]
Options
-h, --help help for list
--branch string branch name or UUID to filter by (omit for main branch)
--include-branches include main branch and all merged branches in results
--limit int maximum number of entries to return (default 100)
--output string output format (table, json) (default "table")
--since string show entries since this duration or ISO-8601 timestamp (default "7d")
Examples
memory journal list # last 7 days
memory journal list --since 24h # last 24 hours
memory journal list --since 2026-01-15T10:00:00Z # since ISO timestamp
memory journal list --limit 50 --output json # cap results, JSON output
memory journal list --branch my-feature # entries for a branch
memory journal list --include-branches # main + all merged branches
memory journal note
Add a note to the project journal
Synopsis
Add a manual markdown note to the project journal. Notes can be standalone or
attached to a specific journal entry via --entry.
The note text can be passed as a positional argument, piped via stdin, or
omitted to open $EDITOR.
Usage
memory journal note [text] [flags]
Options
--entry string (optional) attach this note to a specific journal entry ID
-h, --help help for note
Examples
memory journal note "Skipped worker services โ need schema clarification first."
memory journal note # opens $EDITORecho"Some context" | memory journal note # pipe from stdin
memory journal note --entry <entry-id> "explanation"# attach to a specific entry
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_API_KEY
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 orgs
Manage organizations
Synopsis
Commands for managing organizations in the Memory platform
Options
-h, --help help for orgs
memory orgs create
Create a new organization
Synopsis
Create a new organization in the Memory platform.
Prints the new organization's Name and ID on success.
memory orgs create [flags]
Options
-h, --help help for create
--name string Organization name (required)
memory orgs delete
Delete an organization
Synopsis
Permanently delete an organization by ID.
memory orgs delete <id> [flags]
Options
-h, --help help for delete
memory orgs get
Get organization details
Synopsis
Get details for a specific organization by ID.
memory orgs get <id> [flags]
Options
-h, --help help for get
memory orgs list
List all organizations
Synopsis
List all organizations you are a member of.
Output prints a numbered list with each organization's Name and ID.
memory orgs list [flags]
Options
-h, --help help for list
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_API_KEY so subsequent CLI commands pick it up automatically.
Scopes default to: data:read data:write schema:read agents:read agents:write
-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.
--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.
--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.
--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_API_KEY 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 projects team
Manage project team members
Synopsis
Commands for listing, inviting, and removing members of a project
Options
-h, --help help for team
memory projects team invite
Invite someone to the project
Synopsis
Send an email invitation to join the project.
The invited user will receive an email with CLI install instructions and an
accept link. Use --role to control the access level (default: project_viewer).
memory projects team invite <email> [project-name-or-id] [flags]
Options
-h, --help help for invite
--role string Role to assign (project_viewer, project_user, project_admin) (default "project_viewer")
memory projects team list
List project team members
Synopsis
List all members of a project with their roles and join dates. Use --stats for last-active info.
memory projects team list [project-name-or-id] [flags]
Options
-h, --help help for list
--json Output as JSON
--stats Show last-active stats per member
memory projects team remove
Remove a member from the project
Synopsis
Remove a user from the project by email. Use --yes to skip confirmation.
memory projects team remove <email> [project-name-or-id] [flags]
Options
-h, --help help for remove
-y, --yes Skip confirmation prompt
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.
--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
