Skip to content

Usage Examples

These examples assume you have configured a Backboard API key (see Configuration). Commands that read from a memory bank such as search, list, and stats also need an assistant ID. You can set one explicitly or let the first successful agent-memory add create it for you.

Add Memories

From command argument:

agent-memory add "Project kickoff is Monday at 09:00."

From stdin:

cat notes.txt | agent-memory add

Search Memories

agent-memory search "kickoff"
agent-memory search "project schedule" --limit 3 --format json

List with Pagination

agent-memory list --page 1 --page-size 20
agent-memory list --page 2 --page-size 20 --format json

Update and Delete by ID

agent-memory update mem_123 "Project kickoff moved to Tuesday 10:00."
agent-memory delete mem_123

JSON Output for Automation

agent-memory list --format json
agent-memory stats --format json
agent-memory status op_456 --format json

End-to-End Workflow

# 1) Configure auth
agent-memory config set api-key <your-api-key>

# 2) Add memory
#    (creates assistant-id automatically on first run if needed)
agent-memory add "User prefers concise bullet summaries."

# 3) Search memory
agent-memory search "concise summaries" --limit 5

# 4) Inspect usage
agent-memory stats

# 5) Launch Web UI
agent-memory web