# Sheriff

> Find JavaScript and TypeScript test gaps, write and run tests, and keep coverage aligned with your changes using Sheriff for Claude Code and Codex.

Sheriff is MIT licensed. Claude Code or Codex access and model usage are separate.

## Documentation

- [Basic Usage](https://sheriff-website-omega.vercel.app/docs/basic-usage): Run your first Sheriff test workflow in Claude Code or Codex. Discover coverage gaps, review a test plan, and write and run tests for your project.
- [Installation](https://sheriff-website-omega.vercel.app/docs/installation): Install Sheriff for Claude Code, Codex, or both. Follow the npm setup guide and choose a project-local or global installation for your test workflows.
- [Commands](https://sheriff-website-omega.vercel.app/docs/commands): Explore Sheriff commands for Claude Code and Codex, including run, audit, sync, resume, and reset, with syntax and examples for your test workflows.
- [Configuration](https://sheriff-website-omega.vercel.app/docs/configuration): Configure Sheriff test scope, test runners, and failure behavior. Control how Claude Code and Codex discover gaps, run tests, and handle source defects.
- [Update and uninstall](https://sheriff-website-omega.vercel.app/docs/updates): Update or uninstall Sheriff for Claude Code and Codex. Manage project-local and global installations and keep your test workflows up to date.
- [Resume and reset](https://sheriff-website-omega.vercel.app/docs/recovery): Resume interrupted Sheriff workflows, retry a phase, or reset a plan. Recover your testing progress in Claude Code and Codex without starting over.
- [Stay in sync](https://sheriff-website-omega.vercel.app/docs/sync): Keep tests aligned with code changes using Sheriff sync. Refresh coverage for changed JavaScript and TypeScript files in Claude Code or Codex.
- [Introduction](https://sheriff-website-omega.vercel.app/docs): Sheriff brings open-source test workflows to Claude Code and Codex. Learn how to find test gaps, write tests, and keep JavaScript and TypeScript coverage in sync.

## Optional

- [Full documentation as Markdown](https://sheriff-website-omega.vercel.app/llms-full.txt)
- [Source code](https://github.com/dagim-shimelis/sheriff)
- [npm package](https://www.npmjs.com/package/@dagim_codes/sheriff)