Skip to content

Keprix Documentation

Keprix is a self-hosted AI agent OS (Community Edition). You run it on your own hardware; your data stays under your control.

This site is the complete operator and developer reference for every workspace surface, admin tool, integration, and API.

Start here

I want to... Read
Install CLI / TUI (curl primary) Install Keprix
Run the full Docker stack Quickstart
Complete setup after install First run
Understand the full product Full product map
Configure .env and providers Environment variables, LLM providers
Use chat, tools, and the terminal Command Center Chat, Terminal UI, TUI slash commands
Configure the instance Settings, Admin dashboard
Protect inbound channels Channel Shield
Call the REST API API reference, Developer platform
Harden production Hardening
Fix a broken click, Soft Wall, CRM, or Companies House issue Troubleshooting
Teach the agent about Keprix itself Self-knowledge (keprix memory index-self)

Marketing site: https://keprixai.com (origin may still be provisioning; see public GTM notes).

curl -fsSL https://raw.githubusercontent.com/malike2356/keprix/main/scripts/install.sh | bash

Requires a public GitHub repository. Until then, clone via SSH and run bash scripts/install.sh from the checkout.

Product map

Workspace (daily use)

Area Route Documentation
Home /home Workspace overview
Chat /chat Chat, Web voice input
Terminal Command Center keprix tui Terminal UI, TUI slash commands
Documents /documents Documents
Notes /notes Notes
Tasks /tasks Tasks
Calendar /calendar Calendar
Email /email Email
Contacts /contacts Contacts
Gallery /gallery Gallery
Brain /brain/graph Brain graph
Memory (list) /memory Memory and RAG
Settings /settings Settings
Billing /settings/billing Billing

Apps, research, and data

Area Route Documentation
Skills Hub /skills Skills and plugins
Hub / packs /hub, /domain-packs Hub and domain packs
Built apps /apps/[slug] Built apps navigation
Deep research /research Research
Compare models /compare Compare models
Opportunities /opportunities Opportunity engine
Local models /playbook Local models
Analytics /analytics Analytics workspace
Observability /observability Evals and observability
Notebook research /research/notebooks Notebook research bridge
Agentic CRM /crm Agentic CRM, CRM troubleshooting
Outreach / Soft Wall /outreach Soft Wall, Outreach troubleshooting
Companies House /companies-house, /outreach/companies-house Companies House
Universal Sidecar product /v1/products/... Universal Sidecar
Propreneur sidecar pack propreneur Propreneur sidecar

Automations and agent runtime

Area Route Documentation
Agent chat runtime (via /chat) Agent
Self-coding /admin/coding Self-coding agent
Playbooks /playbooks Playbooks
Cron jobs /admin/cron Cron jobs
Tools /admin/tools Built-in tools
Agent OS /agent-os Agent OS overview, Run ledger
Agent Studio /agent-studio Agent Studio
Agent Apps /agent-apps Agent Apps
A2A /a2a A2A
MCP /admin/mcp MCP, Notion & Trello
Control Center /control-center Control Center

Security, governance, admin

Area Route Documentation
Vault /vault Vault
Governance /settings/governance Governance
Review gateway /review-gateway Review gateway
Channel Shield /channel-shield, /settings/channel-shield Channel Shield
Admin dashboard /dashboard Admin dashboard
Feature flags /admin/feature-flags Feature flags
Navigation policy (sidebar) Navigation and roles
Readiness /admin/readiness Readiness
Developer /developer Developer platform
Notifications /notifications Notifications

Health checks

curl -s http://127.0.0.1:3333/api/health
  • Backend API: http://localhost:3333
  • Web UI: http://localhost:3000
  • Interactive API explorer: http://localhost:3000/api/docs
  • MkDocs (local): bash scripts/serve-docs.sh then http://127.0.0.1:8000

Support