Hippocortex/Docs
GitHubDashboard

Installation

This page covers all the ways to install and configure Hippocortex. Choose the method that fits your stack.

Setup Wizard (Recommended)

The fastest way to install and configure Hippocortex for any integration:

npx @hippocortex/setup

The wizard detects your environment, installs the right package, and configures everything. It works for OpenClaw plugins, SDK projects, and MCP server setups.

To update an existing installation:

npx @hippocortex/setup --update

JavaScript / TypeScript SDK

For direct SDK integration in Node.js projects:

npx @hippocortex/setup

Or install manually:

npm install @hippocortex/sdk

Requires Node.js 18+ (uses native fetch).

Python SDK

pip install hippocortex

Requires Python 3.10+ and uses httpx for async HTTP.

Optional Dependencies

Framework adapters have optional dependencies. Install only what you need:

pip install hippocortex[openai]      # OpenAI Agents adapter
pip install hippocortex[langgraph]   # LangGraph adapter
pip install hippocortex[crewai]      # CrewAI adapter
pip install hippocortex[autogen]     # AutoGen adapter
pip install hippocortex[openclaw]    # OpenClaw adapter
pip install hippocortex[all]         # All adapters

Configuration

The SDK resolves configuration in this order (first match wins):

  1. Constructor arguments passed directly to Hippocortex() or wrap()
  2. Environment variables (HIPPOCORTEX_API_KEY, HIPPOCORTEX_BASE_URL)
  3. Config file (.hippocortex.json in the project root)

Environment Variables

VariableDescriptionDefault
HIPPOCORTEX_API_KEYYour API key (hx_live_* or hx_test_*)Required
HIPPOCORTEX_BASE_URLAPI base URLhttps://api.hippocortex.dev
HIPPOCORTEX_SILENTSet to 1 to suppress console output0

Config File

Create a .hippocortex.json in your project root:

{
  "apiKey": "hx_test_your_key_here",
  "baseUrl": "https://api.hippocortex.dev"
}

Add .hippocortex.json to your .gitignore to avoid committing API keys.

API Key Types

PrefixEnvironmentBillingUse For
hx_test_*TestNo billingDevelopment, CI, staging
hx_live_*ProductionBilledProduction workloads

Test and production environments are completely isolated. Data captured with a test key is never visible to production keys and vice versa.

Verifying Your Installation

TypeScript:

import { Hippocortex } from '@hippocortex/sdk'

const hx = new Hippocortex()
const result = await hx.synthesize({ query: 'test' })
console.log('Connected:', result.ok)

Python:

import asyncio
from hippocortex import Hippocortex

async def main():
    hx = Hippocortex()
    result = await hx.synthesize(query="test")
    print("Connected:", result.ok)

asyncio.run(main())

Next Steps