2.2 KiB
| sidebar_position |
|---|
| 0 |
Installation
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Choose Your Setup
All-in-One (Recommended)
The hindsight-all package includes everything: embedded PostgreSQL, HTTP API server, and Python client.
pip install hindsight-all
Use when: You want the simplest setup for development or small deployments.
Client Only
If you already have a Hindsight server running:
pip install hindsight-client
Use when: You're connecting to an existing Hindsight server (development, staging, or production).
npm install @hindsight/client
Requires: A running Hindsight server (see Server Deployment for setup).
# Coming soon
The CLI is included with the Rust distribution. See CLI documentation for installation.
LLM Provider Setup
Hindsight requires an LLM for fact extraction and reasoning. Configure your provider:
export OPENAI_API_KEY=sk-...
Models: gpt-4o, gpt-4o-mini, gpt-4-turbo
export GROQ_API_KEY=gsk_...
Models: llama-3.3-70b-versatile, mixtral-8x7b-32768
# No API key needed - runs locally
Models: llama3.1, mistral, qwen2.5
See Ollama documentation for setup.
Verify Installation
import hindsight
print(hindsight.__version__)
const { HindsightClient } = require('@hindsight/client');
console.log('Hindsight client loaded');
hindsight --version
Next Steps
- Quick Start — Get running in 60 seconds
- Server Deployment — Production setup options