Skip to main content

Turn your AI agents into team subject matter experts with shared, human-curated knowledge

Project description

Kluris

Turn your AI agents into team subject matter experts.

When your best engineer sleeps, Kluris doesn't. When they leave, Kluris stays.

What is Kluris?

Kluris gives every AI agent on your team shared knowledge -- architecture, decisions, conventions, learnings -- so they work like an SME who knows your entire codebase, not a generic assistant starting from scratch every time.

Knowledge is stored in a brain: a git-backed repo of structured markdown that agents read, search, and apply automatically. The human and agent curate the brain together -- the agent proposes what to document, the human reviews and approves every piece.

Why not a wiki, Notion, or CLAUDE.md?

  • Wikis and Notion are for humans. Agents can't read them, search across them, or write back. A brain is markdown in git -- AI-native.
  • CLAUDE.md is per-project and per-tool. A brain sits above all your projects and works with every AI agent on the team.
  • Agent memory is agent-controlled -- the agent decides what to keep. A brain is human-curated -- you decide what goes in, review every entry, and correct anything that's wrong.

One brain serves all your projects. Every agent reads the same knowledge. Version-controlled, human-curated, shared across the entire team.

Install

macOS:

brew install pipx && pipx ensurepath

Linux:

python3 -m pip install --user pipx && pipx ensurepath

Windows:

pip install pipx && pipx ensurepath

Then restart your terminal and:

pipx install kluris

Quick start

kluris doctor        # check prerequisites
kluris create        # interactive wizard -- name, type, location, git

Then open any project directory and use /kluris:

/kluris learn everything about this service

The agent analyzes your code and walks you through each finding one at a time. You see a small preview before anything is written, and you approve, edit, or skip every piece.

Joining an existing brain

kluris clone git@github.com:team/brain.git    # clone and register

Learning a project

Open any project directory and use /kluris -- the agent analyzes your code and walks you through each finding. You review, edit, and approve before anything is written.

/kluris learn the API endpoints and data model
/kluris learn the Docker and deployment setup
/kluris learn everything about this service

The agent starts with a preview before writing. You can change the target lobe, edit the content, add context the code doesn't show, or skip.

Storing decisions and knowledge

/kluris remember we chose raw SQL over JPA for query complexity
/kluris remember all timestamps must be TIMESTAMPTZ
/kluris create a decision record about the auth architecture
/kluris create an incident report for the January outage

Using brain knowledge while coding

/kluris search auth flow
/kluris search Docker setup
/kluris what do we know about the auth flow?
/kluris implement the new endpoint following our conventions
/kluris fix the token refresh -- use brain knowledge

The agent reads the brain first, then works on the task. If your code contradicts a documented decision, it flags the conflict.

Maintaining the brain

kluris dream         # regenerate maps, fix links, validate structure
kluris push          # commit and push to git (if brain uses git)
kluris status        # brain tree, neuron counts, recent changes
kluris mri --open    # generate and open in browser

What a brain looks like

acme-brain/
├── kluris.yml              # Local config (gitignored -- your agents, branch)
├── brain.md                # Root lobes directory (auto-generated)
├── glossary.md             # Domain terms (hand-edited)
├── README.md               # Usage guide
├── projects/
│   ├── map.md              # Lobe index (auto-generated)
│   └── btb-core/
│       ├── map.md
│       ├── data-model.md   # <- neuron
│       └── auth-flow.md    # <- neuron
├── infrastructure/
│   ├── map.md
│   ├── docker-builds.md    # <- neuron
│   └── environments.md     # <- neuron
└── knowledge/
    ├── map.md
    └── use-raw-sql.md      # <- neuron (decision template)

Folders are lobes (knowledge regions). Files are neurons (knowledge units). Links between neurons are synapses. Auto-generated map.md files keep everything navigable.

Brain types (scaffolding only)

Types determine the initial folder structure. After creation, every brain works the same -- all templates and commands are available regardless of type. You can add or remove lobes freely after creation.

product-group (default)

For a group of projects/services that share knowledge. Example: a platform with 3 backends, a frontend, and shared infrastructure.

Lobe What goes in it
projects/ Per-project sub-folders -- APIs, data models, setup, conventions
infrastructure/ Hosting, CI/CD, Docker, deployment, environments, env vars
knowledge/ Decisions, learnings, troubleshooting tips, domain expertise

The projects/ lobe nests deeper -- one sub-folder per project:

projects/
├── map.md
├── btb-core/
│   ├── map.md
│   ├── auth-flow.md
│   └── endpoints/
│       ├── map.md
│       └── post-auth-login.md
├── btb-frontend/
│   ├── map.md
│   └── state-management.md
└── btb-summon/
    └── map.md

Project neurons link to infrastructure neurons for deployment details and environments -- never duplicate infra content across lobes.

personal

For an individual developer's knowledge -- projects, tasks, and notes.

Lobe What goes in it
projects/ Sub-folder per project: branches, status, TODOs
tasks/ Current priorities, blockers, in-progress work
notes/ Daily notes, ideas, learnings

product

For product management -- requirements, features, and user research.

Lobe What goes in it
prd/ Requirements, user stories, acceptance criteria
features/ Sub-folder per feature: specs, status, feedback
ux/ User research, personas, journey maps, wireframes
analytics/ Metrics, KPIs, experiment results
competitors/ Competitive analysis, market positioning
decisions/ Product decisions and rationale

research

For research projects -- literature, experiments, and findings.

Lobe What goes in it
literature/ Papers, articles, summaries, key findings
experiments/ Hypotheses, methodology, results
findings/ Synthesized insights, conclusions
datasets/ Data sources, schemas, access notes
tools/ Research tools, scripts, environments
questions/ Open questions, hypotheses to test

blank

Empty -- build your own structure from scratch.

How it works

  1. kluris create -- create a brain (interactive wizard)
  2. kluris install-skills -- give the /kluris skill to your AI agents
  3. Open any project and use /kluris -- the agent becomes an SME
  4. Agent and human curate the brain together -- you review and approve every entry
  5. kluris dream -- maintain brain structure
  6. kluris mri -- visualize the brain

CLI commands

Command What it does
kluris create Create a new brain (interactive wizard)
kluris clone <url> Clone a brain from git
kluris list List registered brains
kluris use <name> Switch the active brain
kluris status Brain tree, neuron counts, recent changes
kluris neuron <name> Create a neuron (optionally with --lobe and --template)
kluris lobe <name> Create a new lobe (optionally with --parent for nesting)
kluris dream Regenerate maps, fix links, validate structure
kluris push Commit and push brain changes to git
kluris mri Visualize the brain (opens in browser by default)
kluris templates List available neuron templates
kluris install-skills Install the /kluris skill for your AI agents
kluris uninstall-skills Remove the /kluris skill from AI agent directories
kluris remove <name> Unregister a brain (keeps files on disk)
kluris doctor Check prerequisites (git, Python, config)
kluris help Show command help

All commands support --json for machine-readable output. The CLI is for mechanical operations. Search and guided documentation happen through /kluris inside your agent.

Neuron templates

Available in every brain. Use kluris templates to see them.

Template Sections
decision Context, Decision, Rationale, Alternatives considered, Consequences
incident Summary, Timeline, Root cause, Impact, Resolution, Lessons learned
runbook Purpose, Prerequisites, Steps, Rollback, Contacts

Local config (kluris.yml)

Each brain has a kluris.yml that is gitignored -- it's your local config, not shared. Each team member can have different settings.

name: my-brain
description: my-brain knowledge base
git:
  default_branch: main
  commit_prefix: "brain:"

Brain vocabulary

Term Meaning
Brain Git repo of shared team knowledge
Lobe Folder / knowledge region
Neuron Single knowledge file
Synapse Link between neurons (bidirectional)
Map map.md -- auto-generated lobe index
MRI Interactive brain visualization
Dream Brain maintenance -- regenerate maps, update dates, auto-fix safe issues, validate remaining links

Supported agents

Claude Code, Cursor, Windsurf, GitHub Copilot, Codex, Gemini CLI, Kilo Code, Junie

License

MIT

Project details


Release history Release notifications | RSS feed

This version

1.5.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kluris-1.5.1.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kluris-1.5.1-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

Details for the file kluris-1.5.1.tar.gz.

File metadata

  • Download URL: kluris-1.5.1.tar.gz
  • Upload date:
  • Size: 63.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kluris-1.5.1.tar.gz
Algorithm Hash digest
SHA256 344f237382defceaf58df4639bcc01d5e7c3153eec69b0f27caf51a78692fcf0
MD5 66f80c92b8ca99d70af97a0ea9cce1e4
BLAKE2b-256 e03c18a69c09da804959f970d3d53963209e0e3350a7c98a754a62530e55183a

See more details on using hashes here.

Provenance

The following attestation bundles were made for kluris-1.5.1.tar.gz:

Publisher: publish.yml on ngvoicu/kluris-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kluris-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: kluris-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 50.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kluris-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c944804175ac71193ca5b4c96c95a8fd2cded1a94c1cc28f036d1def7aa7aa2f
MD5 8dc1208da35410c736f2fef922f05574
BLAKE2b-256 c37ea29892f66e9376ef405d927925c5c68741e2e835dfbaf3ca2f71becab66c

See more details on using hashes here.

Provenance

The following attestation bundles were made for kluris-1.5.1-py3-none-any.whl:

Publisher: publish.yml on ngvoicu/kluris-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page