# typos — Source Code Spell Checker for CI

> typos catches spelling mistakes in code, docs, config, and comments with low false positives. Run it locally, in pre-commit, or as a CI gate.

## Install

Copy the content below into your project:

## Quick Use

1. Install the verified package or repo entrypoint:

```bash
cargo install typos-cli
```

2. Run the first local check:

```bash
typos .
```

3. Add a repeatable verification command:

```bash
typos --format brief .
```

---

## Intro

typos is a verified GitHub-backed tool for modern AI and developer workflows, sourced from `crate-ci/typos` with 3,935 stars and a Apache-2.0 license snapshot. Best for: teams that review docs, prompts, config keys, and user-visible strings where small typos create avoidable trust issues. Works with: Rust cargo installs, pre-commit, GitHub Actions, custom dictionaries, generated-file excludes. Setup time: 5 minutes. Use it when you need a concrete, repeatable path rather than another one-off shell snippet.

---

## Operating Pattern

### Fit check

| Question | Practical answer |
|---|---|
| What do you install? | `typos-cli` from `crate-ci/typos` |
| What is the first command? | `typos .` |
| What proves it works? | `typos --format brief .` |
| How long should a pilot take? | 5 minutes for a small repo or sandbox |

### Adoption loop

1. Run the tool on a disposable branch or sandbox project.
2. Capture before/after output so reviewers can see the exact effect.
3. Add the smallest CI or local check that prevents regressions.
4. Document owner, upgrade command, and rollback command in the repo.

### Recommended use

Add it after formatting but before release notes. The fastest win is catching typos in README, prompt assets, CLI help text, and changelog entries.

### Guardrails

Seed a project dictionary for product names and abbreviations; otherwise reviewers will waste time dismissing expected terms.

### Rollout checklist

- Pin the package or release version before using it in CI.
- Keep credentials in environment variables or the platform secret store.
- Add one owner who is responsible for upgrades and breaking-change triage.
- Re-check the GitHub repo before writing docs that mention APIs or install paths.


---

### FAQ

**Q: Is this production-ready?**
A: The repo exists at `https://github.com/crate-ci/typos` and has 3,935 GitHub stars. Treat the first rollout as a controlled pilot until your team has tested install, rollback, and CI behavior.

**Q: Why use it instead of a generic script?**
A: The value is repeatability: a named package, a documented command, a source repo, and a small verification path that can be reviewed by teammates.

**Q: What should I measure first?**
A: Measure setup time against the 5 minutes target, count how many files or tasks it changes, and record whether the CI command catches the same issue locally.

---

## Source & Thanks

> Built from [crate-ci/typos](https://github.com/crate-ci/typos). License: Apache-2.0.
>
> GitHub stars verified from `api.github.com/repos/crate-ci/typos`: 3,935.

---

<!-- ZH -->

## 快速使用

1. 安装已验证的包或仓库入口：

```bash
cargo install typos-cli
```

2. 跑第一次本地检查：

```bash
typos .
```

3. 加一个可重复验证命令：

```bash
typos --format brief .
```

---

## 简介

typos 是一个已通过 GitHub 仓库验证的现代 AI / 开发者工具，来源 `crate-ci/typos`，当前星标快照 3,935，许可证 Apache-2.0。适合：需要 review 文档、提示词、配置 key 和用户可见文案，且小拼写错误会影响信任感的团队。兼容：Rust cargo 安装、pre-commit、GitHub Actions、自定义词典、生成文件排除。装机时间：5 minutes。当你需要的是可重复落地路径，而不是一次性 shell 片段时，用它。

---

## 操作模式

### 适配检查

| 问题 | 实用答案 |
|---|---|
| 安装什么？ | 来自 `crate-ci/typos` 的 `typos-cli` |
| 第一条命令？ | `typos .` |
| 如何证明可用？ | `typos --format brief .` |
| 小范围试点多久？ | 小仓库或 sandbox 约 5 minutes |

### 接入循环

1. 先在一次性分支或 sandbox 项目里跑。
2. 记录 before / after 输出，让 reviewer 看见实际影响。
3. 加最小的 CI 或本地检查，防止同类问题回归。
4. 在仓库文档里写清 owner、升级命令和回滚命令。

### 推荐用法

把它放在格式化之后、release notes 之前。最快收益是抓 README、提示词资产、CLI help 和 changelog 里的拼写错误。

### 风险边界

为产品名和缩写准备项目词典；否则 reviewer 会浪费时间关闭预期词汇。

### 推广检查表

- 进入 CI 前固定包版本或 release 版本。
- 凭据放进环境变量或平台 secret store。
- 指定一个 owner 负责升级和 breaking change 分流。
- 文档里写 API 或安装路径前，重新核验 GitHub 仓库。


---

### FAQ

**Q: 能直接上生产吗？**
A: 仓库已验证存在：`https://github.com/crate-ci/typos`，GitHub 星标 3,935。第一次上线仍建议控制试点，先验证安装、回滚和 CI 行为。

**Q: 为什么不用普通脚本？**
A: 价值在可重复：有命名包、文档化命令、源仓库和可被团队 review 的最小验证路径。

**Q: 第一步应该量什么？**
A: 先量装机时间是否接近 5 minutes，它改了多少文件或任务，以及 CI 命令是否能在本地抓到同类问题。

---

## 来源与感谢

> 来源：[crate-ci/typos](https://github.com/crate-ci/typos)。许可证：Apache-2.0。
>
> GitHub stars 已通过 `api.github.com/repos/crate-ci/typos` 验证：3,935。


---
Source: https://tokrepo.com/en/workflows/typos-source-code-spell-checker-for-ci
Author: crate-ci