# AI use cases for Seiso (scarletkc/seiso)

Repo: [scarletkc/seiso](https://github.com/scarletkc/seiso) | Use cases: 3 | Page: https://dedupedai.com/use-cases/scarletkc-seiso/

seiso is a Rust command-line linter that checks Markdown project docs against a shared convention so that humans and AI agents can rely on them.

This file holds every use case of this repo. Each one starts with a "## " heading and ends with its URL.

- Check project docs against a shared Markdown convention: https://dedupedai.com/use-cases/scarletkc-seiso/check-project-docs-against-convention/
- Have an agent repair Seiso findings in project docs: https://dedupedai.com/use-cases/scarletkc-seiso/agent-repairs-seiso-findings/
- Gate doc changes with Seiso in Claude Code hooks or CI: https://dedupedai.com/use-cases/scarletkc-seiso/gate-doc-changes-with-seiso-hooks/

## How to check project docs against a shared Markdown convention with Seiso

Repo: [scarletkc/seiso](https://github.com/scarletkc/seiso) | Difficulty: Intermediate | Time: 30 minutes | Basis: From the README

Run Seiso on a repo to list stable-rule findings in its Markdown docs.

**Who it is for:** A maintainer whose project docs are mostly written by AI and who needs to catch stale or duplicated facts before review.

**The problem:** AI writes docs faster than anyone can review them, and a stale version number or a field list updated in only one copy misleads readers and agents.

**The outcome:** A list of findings, each with the file, the problem, and how to fix it, from the stable rules that run by default.

### Steps

1. Install Seiso with `cargo install seiso`, or run `uv tool install seiso`, or run `npm install -g @scarletkc/seiso`.
2. From the repository root, run `seiso init`.
3. Review the generated `seiso.toml` for exclusions, kind mappings, and documentation site entries before relying on results.
4. Run `seiso check`.
5. Read each finding and fix the file it names, using the fix given in the diagnostic.

### Prompt to paste into your agent

```text
In the repository at <repo path>, run `seiso check` from the repository root. Report the total number of findings and the file path and rule name of the first finding. Verify that the report only lists stable rules, since preview rules are not run by default.
```

### Caveat

Seiso only checks documents against its convention and does not judge whether prose sounds machine-written or fix spelling and formatting.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/scarletkc-seiso/check-project-docs-against-convention/

## How to have an agent repair Seiso findings in project docs with Seiso

Repo: [scarletkc/seiso](https://github.com/scarletkc/seiso) | Difficulty: Intermediate | Time: 45 minutes | Basis: From the README

Let a coding agent use Seiso diagnostics to fix most doc findings and rerun the check.

**Who it is for:** A developer who wants an AI agent to clean up a docs folder after a large batch of AI-written pages.

**The problem:** Each finding must be fixed by hand, and some fixes need a judgment about which page owns a fact.

**The outcome:** A set of doc edits where mechanical findings are fixed and judgment calls are listed with the decision each one needs.

### Steps

1. Run `seiso check` at the repository root and save the findings.
2. Run `seiso rule --all` to see each rule's status.
3. For a rule you do not understand, explain it with `seiso rule <rule-name>`. (inferred, check the README)
4. Edit the named files to apply each fix, leaving judgment calls for a human to decide.
5. Run `seiso check` again and confirm the findings are gone or listed as decisions.

### Prompt to paste into your agent

```text
In the repository at <repo path>, run `seiso check`, fix the findings the diagnostics give a direct fix for, and run `seiso check` again. Report how many findings remain and list each remaining one as a decision that needs a human. Verify that no fix changed a fact that appears on more than one page without updating the page that owns it.
```

### Caveat

The README says a fix that needs a judgment, such as which of two pages owns a fact, is named as a decision rather than made by Seiso, so an agent still needs a human to settle those.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/scarletkc-seiso/agent-repairs-seiso-findings/

## How to gate doc changes with Seiso in Claude Code hooks or CI with Seiso

Repo: [scarletkc/seiso](https://github.com/scarletkc/seiso) | Difficulty: Advanced | Time: 1 hour | Basis: From the README

Run Seiso automatically when an agent or a commit changes project docs.

**Who it is for:** A team using Claude Code or a CI pipeline that wants doc checks to run without someone remembering to run them.

**The problem:** Doc drift and repeated AI mistakes reach the main branch because nothing checks the docs at the moment they change.

**The outcome:** Doc changes are checked by Seiso in the agent session or the pipeline, with stable rules as the gate.

### Steps

1. Install Seiso and run `seiso init` at the repository root.
2. Read the integrations guide for Claude Code hooks, pre-commit, and CI.
3. Add `seiso check` to the Claude Code hook or the CI job, following the integrations guide.
4. Keep preview rules out of the gate, since the README says they can report false positives.

### Prompt to paste into your agent

```text
In the repository at <repo path>, configure a Claude Code hook that runs `seiso check` after doc edits, following the integrations guide. Report the hook configuration you added and the result of one test run. Verify that the gate runs only stable rules.
```

### Caveat

The README names Claude Code hooks, pre-commit, and CI only as topics in the integrations guide, so the exact setup steps must be taken from that guide and not assumed from this card.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/scarletkc-seiso/gate-doc-changes-with-seiso-hooks/