<!-- generated by epythet -->

# For AI agents

`reci` ships artifacts for coding agents alongside its code. This page lists
them, says where each lives in the repository, and points at the
machine-readable copies of this documentation.

## Skills

Skills are folders holding a `SKILL.md` (the [Agent Skills](https://agentskills.io) format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with `gh skill` (any host: `--agent claude-code`, `copilot`, `cursor`, `codex`, `gemini`), or use the copy bundled in the wheel.

### `ci-advisor`

Discuss and plan what CI/CD actions, jobs, and recipes make sense for a project. Use this skill when the user wants to talk through their CI strategy, asks “what CI actions should I use”, “what recipes make sense for this project”, “help me plan my CI pipeline”, “what should my CI do”, or wants advice on testing, linting, publishing, deployment, or code quality automation. Also trigger when the user asks about specific GitHub Actions, CI best practices, or trade-offs between different CI approaches — even if they haven’t mentioned reci yet.

```bash
gh skill install i2mint/reci ci-advisor --agent claude-code
```

Source: [`reci/data/skills/ci-advisor`](https://github.com/i2mint/reci/tree/HEAD/reci/data/skills/ci-advisor) (bundled with the pip package).

### `ci-migrate`

Migrate an existing GitHub Actions workflow to a reci recipe. Use this skill when the user wants to convert their current CI workflow to reci, says things like “migrate my CI to reci”, “convert my workflow to a recipe”, “refactor my GitHub Actions”, or “I want to use reci for my existing CI”. Also trigger when the user has an existing .github/workflows/ directory and asks about reci — they probably want a migration, not a fresh setup.

```bash
gh skill install i2mint/reci ci-migrate --agent claude-code
```

Source: [`reci/data/skills/ci-migrate`](https://github.com/i2mint/reci/tree/HEAD/reci/data/skills/ci-migrate) (bundled with the pip package).

### `ci-setup`

Create a new CI/CD pipeline for a project using reci recipes. Use this skill whenever the user wants to set up CI, create a GitHub Actions workflow, add continuous integration to their project, or says things like “make a CI setup for me”, “set up CI”, “add CI/CD”, “create a workflow”, or “I need GitHub Actions for this project”. Also trigger when the user asks about setting up testing, linting, publishing, or deployment pipelines — even if they don’t mention “reci” or “CI” explicitly.

```bash
gh skill install i2mint/reci ci-setup --agent claude-code
```

Source: [`reci/data/skills/ci-setup`](https://github.com/i2mint/reci/tree/HEAD/reci/data/skills/ci-setup) (bundled with the pip package).

### `reci-dev`

Guide for contributing to the reci codebase. Use this skill when the user wants to add features, fix bugs, add validation rules, add config adapters, or understand reci’s architecture. Trigger when the user says things like “I want to add a rule”, “how does the compiler work”, “I want to contribute to reci”, or asks about reci internals.

```bash
gh skill install i2mint/reci reci-dev --agent claude-code
```

Source: [`reci/data/skills/reci-dev`](https://github.com/i2mint/reci/tree/HEAD/reci/data/skills/reci-dev) (bundled with the pip package).

The bundled skills are also on disk after `pip install reci`, under the package’s `data/skills/` directory; link them into an agent without network access with `skill link-skills <that directory>`.

## Instruction files

Files agents read before working in this repository.

- [`.claude/CLAUDE.md`](https://github.com/i2mint/reci/tree/HEAD/.claude/CLAUDE.md): read by Claude Code

## Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

- [`llms.txt`](https://i2mint.github.io/reci/llms.txt): an index of every page with a one-line description ([llms.txt](https://llmstxt.org) format)
- [`reci.md`](https://i2mint.github.io/reci/reci.md): the whole documentation as one Markdown file
- `<page>.html.md`: a rendered Markdown twin of every page, advertised from each page’s `<head>` with `<link rel="alternate" type="text/markdown">`
- [`objects.inv`](https://i2mint.github.io/reci/objects.inv): the Sphinx inventory: a symbol-to-URL index (`sphobjinv convert plain objects.inv -`)
