Content
<div align="center">
<img src="./assets/logo.png" width="192" />
# grimoire
**An OCI-backed package manager for AI skills and rules**
[![CI][ci-badge]][ci]
[![Release][release-badge]][releases]
[![Docs][docs-badge]][docs]
[![License][license-badge]][license]
</div>
`grim` installs, maintains, and publishes AI agent skills and rules using OCI
registries (GHCR, Docker Hub, private registries) as storage — the same way
container images are distributed. It is a backend tool: a building block for
keeping agent configuration versioned, shareable, and reproducible.
> **Status:** stabilizing toward 1.0 — released surfaces are frozen
> contracts; pin a version when you depend on it.
## Install
One-line installer (macOS / Linux) — detects your platform, verifies the
SHA-256 checksum, and drops `grim` onto your `PATH`:
```sh
curl --proto '=https' --tlsv1.2 -LsSf https://setup.grimoire.rs/sh | sh
```
On Windows (PowerShell 7.4+):
```powershell
irm https://setup.grimoire.rs/ps1 | iex
```
In GitHub Actions, use [`grimoire-rs/setup-grimoire@v1`][setup-grimoire].
Pre-built binaries for macOS, Linux, and Windows (aarch64 / x86_64) are on
the [latest release][releases]; other methods (ocx, source build) are in the
[installation docs][docs-install]. Or build from source:
```sh
cargo install --git https://github.com/grimoire-rs/grimoire grimoire
```
## Quick Start
```sh
grim init # create grimoire.toml
grim add ghcr.io/grimoire-rs/skills/grim-usage # declare, lock, install
grim install # re-materialize after a clone
grim tui # browse the index
```
Full documentation: **[grimoire docs][docs]**.
## Development
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide.
**Prerequisites:** [Rust](https://rustup.rs), [task](https://taskfile.dev),
[uv](https://docs.astral.sh/uv/) (for the Python acceptance suite).
## Community
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Security Policy](SECURITY.md)
## License
Grimoire is licensed under the [Apache License, Version 2.0][license].
<!-- badges -->
[ci]: https://github.com/grimoire-rs/grimoire/actions/workflows/verify-basic.yml
[ci-badge]: https://github.com/grimoire-rs/grimoire/actions/workflows/verify-basic.yml/badge.svg
[releases]: https://github.com/grimoire-rs/grimoire/releases
[release-badge]: https://img.shields.io/github/v/release/grimoire-rs/grimoire
[docs]: https://grimoire.rs/
[docs-badge]: https://img.shields.io/badge/docs-grimoire-blue
[docs-install]: https://grimoire.rs/installation.html
[setup-grimoire]: https://github.com/grimoire-rs/setup-grimoire
[license]: LICENSE
[license-badge]: https://img.shields.io/badge/license-Apache--2.0-blue.svg
MCP Store