# Clone and setup
git clone https://github.com/campfirein/cipher.git
cd cipher

# Configure environment
cp .env.example .env
# Edit .env with your API keys

# Start with Docker
docker-compose up --build -d

# Test
curl http://localhost:3000/health

💡 Note: Docker builds automatically skip the UI build step to avoid ARM64 compatibility issues with lightningcss. The UI is not included in the Docker image by default.

To include the UI in the Docker build, use: docker build --build-arg BUILD_UI=true .

# Interactive mode
cipher

# One-shot command
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."

# API server mode
cipher --mode api

# MCP server mode
cipher --mode mcp

# Web UI mode
cipher --mode ui

⚠️ Note: When running MCP mode in terminal/shell, export all environment variables as Cipher won't read from .env file.

💡 Tip: CLI mode automatically continues or creates the "default" session. Use /session new <session-name> to start a fresh session.

# LLM Configuration
llm:
  provider: openai # openai, anthropic, openrouter, ollama, qwen
  model: gpt-4-turbo
  apiKey: $OPENAI_API_KEY

# System Prompt
systemPrompt: 'You are a helpful AI assistant with memory capabilities.'

# MCP Servers (optional)
mcpServers:
  filesystem:
    type: stdio
    command: npx
    args: ['-y', '@modelcontextprotocol/server-filesystem', '.']

# ====================
# API Keys (At least one required)
# ====================
OPENAI_API_KEY=sk-your-openai-api-key
ANTHROPIC_API_KEY=sk-ant-your-anthropic-key
GEMINI_API_KEY=your-gemini-api-key
QWEN_API_KEY=your-qwen-api-key

# ====================
# Vector Store (Optional - defaults to in-memory)
# ====================
VECTOR_STORE_TYPE=qdrant  # qdrant, milvus, or in-memory
VECTOR_STORE_URL=https://your-cluster.qdrant.io
VECTOR_STORE_API_KEY=your-qdrant-api-key

# ====================
# Chat History (Optional - defaults to SQLite)
# ====================
CIPHER_PG_URL=postgresql://user:pass@localhost:5432/cipher_db

# ====================
# Workspace Memory (Optional)
# ====================
USE_WORKSPACE_MEMORY=true
WORKSPACE_VECTOR_STORE_COLLECTION=workspace_memory

# ====================
# AWS Bedrock (Optional)
# ====================
AWS_ACCESS_KEY_ID=your-aws-access-key
AWS_SECRET_ACCESS_KEY=your-aws-secret-key
AWS_DEFAULT_REGION=us-east-1

# ====================
# Advanced Options (Optional)
# ====================
# Logging and debugging
CIPHER_LOG_LEVEL=info  # error, warn, info, debug, silly
REDACT_SECRETS=true

# Vector store configuration
VECTOR_STORE_DIMENSION=1536
VECTOR_STORE_DISTANCE=Cosine  # Cosine, Euclidean, Dot, Manhattan
VECTOR_STORE_MAX_VECTORS=10000

# Memory search configuration
SEARCH_MEMORY_TYPE=knowledge  # knowledge, reflection, both (default: knowledge)
DISABLE_REFLECTION_MEMORY=true  # default: true

💡 Tip: Copy .env.example to .env and fill in your values:

cp .env.example .env

• Memory
  • cipher_extract_and_operate_memory: Extracts knowledge and applies ADD/UPDATE/DELETE in one step
  • cipher_memory_search: Semantic search over stored knowledge
  • cipher_store_reasoning_memory: Store high-quality reasoning traces
• Reasoning (Reflection)
  • cipher_extract_reasoning_steps (internal): Extract structured reasoning steps
  • cipher_evaluate_reasoning (internal): Evaluate reasoning quality and suggest improvements
  • cipher_search_reasoning_patterns: Search reflection memory for patterns
• Workspace Memory (team)
  • cipher_workspace_search: Search team/project workspace memory
  • cipher_workspace_store: Background capture of team/project signals
• Knowledge Graph
  • cipher_add_node, cipher_update_node, cipher_delete_node, cipher_add_edge
  • cipher_search_graph, cipher_enhanced_search, cipher_get_neighbors
  • cipher_extract_entities, cipher_query_graph, cipher_relationship_manager
• System
  • cipher_bash: Execute bash commands (one-off or persistent)