Metadata-Version: 2.5
Name: grimoire-kit
Version: 3.73.0
Summary: Dashboard, task board, project memory and evidence check for code you delegate to agents (Claude Code, Copilot).
Project-URL: Homepage, https://github.com/Guilhem-Bonnet/Grimoire-kit
Project-URL: Repository, https://github.com/Guilhem-Bonnet/Grimoire-kit
Project-URL: Documentation, https://guilhem-bonnet.github.io/Grimoire-kit/
Project-URL: Changelog, https://github.com/Guilhem-Bonnet/Grimoire-kit/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/Guilhem-Bonnet/Grimoire-kit/issues
Author: Guilhem Bonnet
License-Expression: MIT
License-File: LICENSE
Keywords: agents,ai,copilot,llm,mcp,workflow
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: rich>=13.0
Requires-Dist: ruamel-yaml>=0.18
Requires-Dist: typer>=0.12
Provides-Extra: all
Requires-Dist: chromadb<0.7,>=0.6; extra == 'all'
Requires-Dist: fastembed>=0.8; extra == 'all'
Requires-Dist: mcp<3,>=2.0; extra == 'all'
Requires-Dist: neo4j>=5.0; extra == 'all'
Requires-Dist: ollama>=0.3; extra == 'all'
Requires-Dist: qdrant-client>=1.9; extra == 'all'
Requires-Dist: redis>=5.0; extra == 'all'
Requires-Dist: tantivy>=0.26; extra == 'all'
Provides-Extra: dev
Requires-Dist: chromadb<0.7,>=0.6; extra == 'dev'
Requires-Dist: fastembed>=0.8; extra == 'dev'
Requires-Dist: hypothesis>=6.100; extra == 'dev'
Requires-Dist: mcp<3,>=2.0; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: neo4j>=5.0; extra == 'dev'
Requires-Dist: ollama>=0.3; extra == 'dev'
Requires-Dist: pre-commit>=4.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest-timeout>=2.3; extra == 'dev'
Requires-Dist: pytest-xdist>=3.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: qdrant-client>=1.9; extra == 'dev'
Requires-Dist: redis>=5.0; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Requires-Dist: tantivy>=0.26; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-gen-files>=0.5; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.6; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocs-redirects>=1.2; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
Requires-Dist: pymdown-extensions>=10.0; extra == 'docs'
Provides-Extra: mcp
Requires-Dist: mcp<3,>=2.0; extra == 'mcp'
Provides-Extra: mempalace
Requires-Dist: chromadb<0.7,>=0.6; extra == 'mempalace'
Provides-Extra: neo4j
Requires-Dist: neo4j>=5.0; extra == 'neo4j'
Provides-Extra: ollama
Requires-Dist: ollama>=0.3; extra == 'ollama'
Provides-Extra: qdrant
Requires-Dist: fastembed>=0.8; extra == 'qdrant'
Requires-Dist: qdrant-client>=1.9; extra == 'qdrant'
Provides-Extra: redis
Requires-Dist: redis>=5.0; extra == 'redis'
Provides-Extra: search
Requires-Dist: tantivy>=0.26; extra == 'search'
Provides-Extra: weaviate
Requires-Dist: fastembed>=0.8; extra == 'weaviate'
Description-Content-Type: text/markdown

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/brand/wordmark-dark.svg">
    <img src="docs/assets/brand/wordmark-light.svg" width="220" alt="Grimoire">
  </picture>
</p>

# grimoire-kit

[![PyPI](https://img.shields.io/pypi/v/grimoire-kit?style=flat&label=PyPI)](https://pypi.org/project/grimoire-kit/)
[![CI](https://img.shields.io/github/actions/workflow/status/Guilhem-Bonnet/Grimoire-kit/ci-sdk.yml?branch=main&style=flat&label=CI)](https://github.com/Guilhem-Bonnet/Grimoire-kit/actions/workflows/ci-sdk.yml)
[![License](https://img.shields.io/github/license/Guilhem-Bonnet/Grimoire-kit?style=flat&label=license)](LICENSE)

Grimoire installs into your repository and gives you, for the code you delegate to agents
(Claude Code, Copilot), a local dashboard, tasks, project memory and an evidence check.

[Website](https://guilhem-bonnet.github.io/Grimoire-kit/) ·
[Manual (in French)](https://guilhem-bonnet.github.io/Grimoire-kit/docs/) ·
[Version française](README.fr.md)

```bash
uv tool install grimoire-kit                   # or: pipx install grimoire-kit
grimoire init . --lite -y                      # sets up the current repository, light profile (no service)
grimoire standard init . --profile governed    # makes the evidence check blocking
```

## The five tools

### The dashboard

A local web page that gathers the Grimoire projects on your machine and their tasks. Started
from a project, it adds that project and opens on it; it does not start sessions, that stays
in your editor.

```bash
grimoire cockpit start    # starts in the background and opens the browser
```

### Tasks

Each piece of work becomes a task with an acceptance criterion. A session takes a task and
hands its work back to you for review.

```bash
grimoire task add "Fix the CSV export" -a "pytest tests/test_export.py passes" --ready
```

### Project memory

What the project decided carries over from one session to the next. Memory belongs to each
project; in the light profile it needs no service.

```bash
grimoire memory remember "We keep SQLite while the volume allows it"
```

### Evidence check

Before a task changes state, Grimoire checks that its evidence exists: a test run, a written
review, a produced file. It refuses for real in the `governed` profile and warns elsewhere;
either way, it names what is missing.

```bash
grimoire standard gate check    # tells which evidence is missing, if any
```

### Install

Start small and enable only what the project needs. Updating goes through a backup and a
preview; anything that needs your call is proposed instead of applied.

```bash
grimoire upgrade-flow run    # guided update, backup first
```

## Under the hood

The manual is in French.

- [Getting started](https://guilhem-bonnet.github.io/Grimoire-kit/docs/getting-started/) ·
  [Command reference](https://guilhem-bonnet.github.io/Grimoire-kit/docs/cli-reference/)
- [Project memory](https://guilhem-bonnet.github.io/Grimoire-kit/docs/memory-system/) ·
  [Evidence check](https://guilhem-bonnet.github.io/Grimoire-kit/docs/standard/) ·
  [Updating](https://guilhem-bonnet.github.io/Grimoire-kit/docs/upgrade/)
- [Hosts, surface by surface](https://guilhem-bonnet.github.io/Grimoire-kit/docs/hosts/)
- [Repository architecture](ARCHITECTURE.md) · [Changelog](CHANGELOG.md)

## Contributing

Issues and change proposals are welcome. The path (environment, tests, contribution rules) is
in [CONTRIBUTING.md](CONTRIBUTING.md). A change to a command updates its reference page in the
same commit.

## License

MIT — see [LICENSE](LICENSE).
