Documentation Index
Fetch the complete documentation index at: https://mintlify.com/vectorize-io/hindsight/llms.txt
Use this file to discover all available pages before exploring further.
The Hindsight CLI (hindsight) provides full command-line access to memory operations, bank management, documents, entities, webhooks, and more. Every command maps directly to the REST API, so --help on any subcommand shows all available flags.
Installation
curl -fsSL https://hindsight.vectorize.io/get-cli | bash
Configuration
Set your API URL
# Interactive
hindsight configure
# Non-interactive
hindsight configure --api-url http://localhost:8888
# With API key
hindsight configure --api-url http://localhost:8888 --api-key your-api-key
Or use environment variables
Environment variables take priority over the config file:export HINDSIGHT_API_URL=http://localhost:8888
export HINDSIGHT_API_KEY=your-api-key
Named profiles
Switch between multiple Hindsight deployments without editing the config file. Each profile is a TOML file stored at ~/.hindsight/cli-profiles/<name>.toml (written with 0600 permissions on Unix).
# Create a profile
hindsight profile create prod \
--api-url https://api.hindsight.vectorize.io \
--api-key hsk_...
# List profiles
hindsight profile list
# Inspect a profile
hindsight profile show prod
# Use for a single command
hindsight -p prod bank list
# Make sticky in the current shell
export HINDSIGHT_PROFILE=prod
# Remove a profile
hindsight profile delete prod -y
Configuration precedence (highest first)
- Environment variables (
HINDSIGHT_API_URL, HINDSIGHT_API_KEY)
- Named profile via
-p <name> or $HINDSIGHT_PROFILE
- Shared config file (
~/.hindsight/config)
- Default (
http://localhost:8888)
Memory commands
hindsight memory retain
Store a memory in a bank.
# Basic
hindsight memory retain <bank_id> "Alice works at Google as a software engineer"
# With context
hindsight memory retain <bank_id> "Bob loves hiking" --context "hobby discussion"
# With a specific event date (ISO 8601)
hindsight memory retain <bank_id> "Project launched" --timestamp 2024-01-15
# Background processing
hindsight memory retain <bank_id> "Meeting notes" --async
# Store without a timestamp
hindsight memory retain <bank_id> "Background fact" --timestamp unset
hindsight memory retain-files
Bulk-ingest files as memories.
# Single file
hindsight memory retain-files <bank_id> notes.txt
# Directory (recursive)
hindsight memory retain-files <bank_id> ./documents/
# With context
hindsight memory retain-files <bank_id> meeting-notes.txt --context "team meeting"
# Named retain strategy
hindsight memory retain-files <bank_id> ./documents/ --strategy conversations
# Background processing
hindsight memory retain-files <bank_id> ./data/ --async
hindsight memory recall
Search memories by semantic similarity.
# Basic
hindsight memory recall <bank_id> "What does Alice do?"
# With budget and token limit
hindsight memory recall <bank_id> "hiking recommendations" \
--budget high \
--max-tokens 8192
# Filter by fact type
hindsight memory recall <bank_id> "query" --fact-type world,observation
# Filter by tags
hindsight memory recall <bank_id> "query" --tags work,project --tags-match all
# Pin results to a specific point in time
hindsight memory recall <bank_id> "query" --query-timestamp "2026-01-15T00:00:00Z"
# Show retrieval trace
hindsight memory recall <bank_id> "query" --trace
hindsight memory reflect
Generate a response using memories and bank disposition.
# Basic
hindsight memory reflect <bank_id> "What do you know about Alice?"
# With additional context
hindsight memory reflect <bank_id> "Should I learn Python?" --context "career advice"
# Higher budget for complex questions
hindsight memory reflect <bank_id> "Summarize my week" --budget high
# Filter fact types and exclude mental models
hindsight memory reflect <bank_id> "What happened last quarter?" \
--fact-types world,experience \
--exclude-mental-models
Other memory subcommands
# View observation history for a memory unit
hindsight memory history <bank_id> <memory_id>
# Remove observations while keeping the core fact
hindsight memory clear-observations <bank_id> <memory_id>
hindsight memory clear-observations <bank_id> <memory_id> -y # skip prompt
Bank commands
# List all banks
hindsight bank list
# View bank disposition
hindsight bank disposition <bank_id>
# Set disposition and mission
hindsight bank set-disposition <bank_id> --mission "..." --name "..."
# View statistics
hindsight bank stats <bank_id>
# Set bank name
hindsight bank name <bank_id> "My Assistant"
# Set mission
hindsight bank mission <bank_id> "I am a helpful AI assistant"
# Clear all observations across the bank
hindsight bank clear-observations <bank_id>
hindsight bank clear-observations <bank_id> -y # skip prompt
# Recover from a failed consolidation
hindsight bank consolidation-recover <bank_id>
Document commands
# List documents in a bank
hindsight document list <bank_id>
# Get document details
hindsight document get <bank_id> <document_id>
# Update document metadata
hindsight document update <bank_id> <document_id> --context "updated context"
# Delete a document and its memories
hindsight document delete <bank_id> <document_id>
Entity commands
# List entities
hindsight entity list <bank_id>
# Get entity details
hindsight entity get <bank_id> <entity_id>
Operation commands
Track and manage async operations such as retain-files and consolidation jobs.
# List operations
hindsight operation list <bank_id>
# Get operation status
hindsight operation get <bank_id> <operation_id>
# Cancel a pending operation
hindsight operation cancel <bank_id> <operation_id>
# Retry a failed operation
hindsight operation retry <bank_id> <operation_id>
Webhook commands
# List webhooks
hindsight webhook list <bank_id>
# Create a webhook (defaults to consolidation.completed events)
hindsight webhook create <bank_id> https://example.com/hook
# Create with specific events and HMAC signing secret
hindsight webhook create <bank_id> https://example.com/hook \
--event-types retain.completed,consolidation.completed \
--secret my-hmac-secret
# Update a webhook
hindsight webhook update <bank_id> <webhook_id> --url https://new-url.com
# Delete a webhook
hindsight webhook delete <bank_id> <webhook_id>
# View delivery history
hindsight webhook deliveries <bank_id> <webhook_id>
Audit logs
# List audit entries
hindsight audit list <bank_id>
# Filter by action and transport
hindsight audit list <bank_id> --action recall --transport mcp
# Filter by date range
hindsight audit list <bank_id> \
--start-date "2026-04-01T00:00:00Z" \
--end-date "2026-04-10T00:00:00Z"
# Pagination
hindsight audit list <bank_id> --limit 50 --offset 100
# Default pretty output
hindsight memory recall <bank_id> "query"
# JSON
hindsight memory recall <bank_id> "query" -o json
# YAML
hindsight memory recall <bank_id> "query" -o yaml
UI and explorer
# Launch the web-based Control Plane UI (requires Node.js)
hindsight ui
# Launch the interactive TUI explorer
hindsight explore
The hindsight explore command opens an interactive terminal interface for browsing banks, running recall queries, and inspecting the knowledge graph. Use arrow keys to navigate, / to search, and q to quit.
Global flags
| Flag | Description |
|---|
-p, --profile <name> | Use a named configuration profile |
-v, --verbose | Show detailed request/response output |
-o, --output <format> | Output format: pretty, json, yaml |
--help | Show help |
--version | Show version |
Example workflow
# Configure once
hindsight configure --api-url http://localhost:8888
# Store memories
hindsight memory retain demo "Alice works at Google"
hindsight memory retain demo "Bob is a data scientist"
hindsight memory retain demo "Alice and Bob are colleagues"
# Search
hindsight memory recall demo "Who works with Alice?"
# Generate a response
hindsight memory reflect demo "What do you know about the team?"
# Check bank disposition
hindsight bank disposition demo