Metadata-Version: 2.5
Name: ryni
Version: 0.1.1
Summary: Share conventions. Catch harness drift.
Requires-Python: >=3.14
Requires-Dist: pyyaml>=6
Requires-Dist: typer>=0.20
Description-Content-Type: text/markdown

# Rýni

**Share conventions. Catch harness drift.**

Rýni helps teams adopt a trusted standard, express their own harness conventions,
and share those conventions as installable Python rule packs.

- **Adopt a pack.** One uv installation activates its rules. No `ryni.toml`.
- **Express your conventions.** Use Python checks or focused agent review instructions.
- **Check with your agent.** The `ryni-check` skill runs checks and delegates every
  pending review to a sub-agent, then combines the findings.
- **Catch drift in CI.** Structured diagnostics and explicit incomplete/pending states.

Rýni runs locally and does not launch a model or require an API key. Agent reviews
use your existing agent. Built-in checks validate skill frontmatter, names,
directory matches, and description length. Python 3.14 or later is required.

## Get started

For a shared repository, add Rýni as a development dependency:

```bash
uv add --dev ryni
uv run ryni check .
```

Add your team's published rule pack as a development dependency too. Replace
`your-team-rules` with its package name:

```bash
uv add --dev your-team-rules
uv run ryni rule
```

Commit `pyproject.toml` and `uv.lock`. Use `uv run ryni` locally and in your agent;
in CI, run `uv sync --locked --group dev` before `uv run --no-sync ryni check .`.
Installed rules are active immediately. See [Your first rule pack](website/first-rule-pack.md)
for a walkthrough of creating, installing, and running a pack.

## Check with your agent

Install the bundled skill into your agent's skills directory:

```bash
uv run ryni skill install .claude/skills
```

Invoke `/ryni-check` in Claude Code. For Codex, install into `.agents/skills` and
invoke `$ryni-check`. An agent with sub-agent support is required for review rules;
missing review capability is reported as incomplete.

## Documentation

- [Overview](website/index.md)
- [Your first rule pack](website/first-rule-pack.md)
- [Working example pack](examples/team-pack/README.md)

Rule packs and agent reviews require Rýni 0.1.1 or later. To try this source version:

```bash
uv run --with-editable . --with ./examples/team-pack ryni check .
```

## Contributing

```bash
uv run pytest tests
uv run ruff check .
uv run --group docs mkdocs build --strict
uv run --group docs mkdocs serve
```

See [our jobs to be done](JTBD.md) for the project's direction.
