vectorize-io__hindsight/hindsight-docs/docs/sdks/cli.md

sidebar_position

sidebar_position
4

CLI Reference

The Hindsight CLI provides command-line access to memory operations and bank management. All commands follow the OpenAPI specification, so you can use --help on any command to see all available options.

Installation

curl -fsSL https://hindsight.vectorize.io/get-cli | bash

Configuration

Configure the API URL:

# Interactive configuration
hindsight configure

# Or set directly
hindsight configure --api-url http://localhost:8888

# With API key for authentication
hindsight configure --api-url http://localhost:8888 --api-key your-api-key

# Or use environment variables (highest priority)
export HINDSIGHT_API_URL=http://localhost:8888
export HINDSIGHT_API_KEY=your-api-key

Named Profiles

When you need to switch between multiple Hindsight deployments (e.g. local, staging, production) without constantly rewriting ~/.hindsight/config, use named profiles. Each profile is a TOML file at ~/.hindsight/cli-profiles/<name>.toml and is selected per-invocation with -p/--profile (or by setting $HINDSIGHT_PROFILE).

# Create (or overwrite) a profile
hindsight profile create prod \
  --api-url https://api.hindsight.vectorize.io \
  --api-key hsk_...

# List and inspect profiles
hindsight profile list
hindsight profile show prod

# Use a profile for a single command
hindsight -p prod bank list

# Or make it sticky for the current shell
export HINDSIGHT_PROFILE=prod
hindsight bank list

# Remove a profile
hindsight profile delete prod -y

Profile files are written with 0600 permissions on Unix so the API key is only readable by the owner.

Configuration precedence (highest first):

1. Environment variables (HINDSIGHT_API_URL, HINDSIGHT_API_KEY)
2. Named profile — explicit -p <name>, otherwise $HINDSIGHT_PROFILE
3. Shared config file (~/.hindsight/config, written by hindsight configure)
4. Default (http://localhost:8888)

HINDSIGHT_API_URL / HINDSIGHT_API_KEY always override profile values, which makes it safe to use -p in scripts while letting CI inject credentials via environment.

Core Commands

Retain (Store Memory)

Store a single memory:

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"

# Queue for background processing
hindsight memory retain <bank_id> "Meeting notes" --async

# With an event date (ISO 8601 datetime or date)
hindsight memory retain <bank_id> "Project launched" --timestamp 2024-01-15

# Store without a timestamp (overrides the default of "now")
hindsight memory retain <bank_id> "Background fact" --timestamp unset

Retain Files

Bulk import from files:

# Single file
hindsight memory retain-files <bank_id> notes.txt

# Directory (recursive by default)
hindsight memory retain-files <bank_id> ./documents/

# With context
hindsight memory retain-files <bank_id> meeting-notes.txt --context "team meeting"

# With a named retain strategy (see retain_strategies in bank config)
hindsight memory retain-files <bank_id> ./documents/ --strategy conversations

# Background processing
hindsight memory retain-files <bank_id> ./data/ --async

Recall (Search)

Search memories using semantic similarity:

hindsight memory recall <bank_id> "What does Alice do?"

# With options
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 time
hindsight memory recall <bank_id> "query" --query-timestamp "2026-01-15T00:00:00Z"

# Show trace information
hindsight memory recall <bank_id> "query" --trace

Reflect (Generate Response)

Generate a response using memories and bank disposition:

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 by fact type
hindsight memory reflect <bank_id> "query" \
  --fact-types world,experience \
  --exclude-mental-models

Memory History

View the observation history for a specific memory unit:

hindsight memory history <bank_id> <memory_id>

Clear Observations

Remove all observations for a memory unit, keeping the core fact:

hindsight memory clear-observations <bank_id> <memory_id>

# Skip confirmation prompt
hindsight memory clear-observations <bank_id> <memory_id> -y

Bank Management

List Banks

hindsight bank list

View Disposition

hindsight bank disposition <bank_id>

Set Disposition

hindsight bank set-disposition <bank_id> --skepticism 3 --literalism 4 --empathy 5

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 interested in technology"

Clear Observations (Bank-wide)

Remove all observations across the entire bank:

hindsight bank clear-observations <bank_id>

# Skip confirmation prompt
hindsight bank clear-observations <bank_id> -y

Recover Consolidation

Recover from a failed or stuck consolidation:

hindsight bank consolidation-recover <bank_id>

Document Management

# List documents
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 document and its memories
hindsight document delete <bank_id> <document_id>

Entity Management

# List entities
hindsight entity list <bank_id>

# Get entity details
hindsight entity get <bank_id> <entity_id>

Operation Management

Track and manage async operations (retain-files, consolidation, etc.):

# 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 Management

Configure event delivery hooks for bank activity:

# 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 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>

Knowledge Base

Manage a bank's knowledge pages — living documents organized in a folder tree. See Knowledge Pages for what they are and how they refresh.

# Show the folder/page tree (pages that have fallen behind are marked stale)
hindsight knowledge-base tree <bank_id>

# Create a folder, optionally nested under another
hindsight knowledge-base create-folder <bank_id> "Operations"
hindsight knowledge-base create-folder <bank_id> "Runbooks" --parent-id <folder_id>

# Create a page — content is generated in the background
hindsight knowledge-base create-page <bank_id> \
  "Deploying the API" \
  "How is the API deployed?" \
  --parent-id <folder_id> \
  --tags ops,type:runbook

# Build a page from raw facts instead of the observation-only default
hindsight knowledge-base create-page <bank_id> "Recent Incidents" \
  "What incidents happened recently?" \
  --fact-types experience,world --mode full

# Read a page as a markdown document
hindsight knowledge-base get-page <bank_id> <page_id>

# Hybrid search (full-text + vector) over whole pages
hindsight knowledge-base search <bank_id> "how do we deploy" --limit 5

# Rename, move, or reconfigure a node
hindsight knowledge-base update <bank_id> <node_id> --name "New name"
hindsight knowledge-base update <bank_id> <page_id> --source-query "New question?"

# Export the whole knowledge base as a markdown bundle
hindsight knowledge-base export <bank_id>

# Delete a folder or page and everything under it
hindsight knowledge-base delete <bank_id> <node_id> -y

:::tip hindsight fs mount --bank <bank_id> mirrors the same knowledge base onto disk as real markdown files, kept current by a background refresh loop — handy when you'd rather use grep, rg, or your editor than the commands above. :::

Audit Logs

Inspect the audit trail for a bank:

# 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

Output Formats

# Pretty (default)
hindsight memory recall <bank_id> "query"

# JSON
hindsight memory recall <bank_id> "query" -o json

# YAML
hindsight memory recall <bank_id> "query" -o yaml

Global Options

Flag	Description
-v, --verbose	Show detailed output including request/response
-o, --output <format>	Output format: pretty, json, yaml
--help	Show help
--version	Show version

Control Plane UI

Launch the web-based Control Plane UI directly from the CLI:

hindsight ui

This runs the Control Plane locally on port 9999 using the API URL from your configuration. The UI provides:

• Memory bank management — Browse and manage all your banks
• Entity explorer — Visualize the knowledge graph
• Query testing — Interactive recall and reflect testing
• Operation history — View ingestion and processing logs

:::tip The UI command requires Node.js to be installed. It automatically downloads and runs the @vectorize-io/hindsight-control-plane package via npx. :::

Interactive Explorer

Launch the TUI explorer for visual navigation of your memory banks:

hindsight explore

The explorer provides an interactive terminal interface to:

• Browse memory banks — View all banks and their statistics
• Search memories — Run recall queries with real-time results
• Inspect memory details — Open a memory to view its text, metadata, entities, and full JSON fields
• Inspect entities — Explore the knowledge graph and entity relationships
• View facts — Browse world facts, experiences, and observations
• Navigate documents — See source documents and their extracted memories

Keyboard Shortcuts

Key	Action
↑/↓	Navigate items
Enter	Select item / view details
Tab	Switch panels
/	Search
q	Quit

Example Workflow

# Configure API URL
hindsight configure --api-url http://localhost:8888

# Store some 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 memories
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