typos

Source code spell checker

Finds and corrects spelling mistakes among source code:

• Fast enough to run on monorepos
• Low false positives so you can run on PRs

Dual-licensed under MIT or Apache 2.0

Documentation

• Installation
• Getting Started
  • False Positives
  • Integrations
    • GitHub Action
    • pre-commit
    • Custom
  • Debugging
• Reference
• FAQ
• Comparison with other spell checkers
• Projects using typos
• Benchmarks
• Design
• Contribute
• CHANGELOG

Install

Download a pre-built binary (installable via gh-install).

Or use rust to install:

cargo install typos-cli

Or use Homebrew to install:

brew install typos-cli

Or use Conda to install:

conda install typos

Or use Pacman to install:

sudo pacman -S typos

Getting Started

Most commonly, you'll either want to see what typos are available with

typos

Or have them fixed

typos --write-changes
typos -w

If there is any ambiguity (multiple possible corrections), typos will just report it to the user and move on.

False-positives

Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content.

To mark a word or an identifier (grouping of words) as valid, add it your _typos.toml by declaring itself as the valid spelling:

[default]
extend-ignore-identifiers-re = [
    # *sigh* this just isn't worth the cost of fixing
    "AttributeID.*Supress.*",
]

[default.extend-identifiers]
# *sigh* this just isn't worth the cost of fixing
AttributeIDSupressMenu = "AttributeIDSupressMenu"

[default.extend-words]
# Don't correct the surname "Teh"
teh = "teh"

For cases like localized content, you can disable spell checking of file contents while still checking the file name:

[type.po]
extend-glob = ["*.po"]
check-file = false

(run typos --type-list to see configured file types)

If you need some more flexibility, you can completely exclude some files from consideration:

[files]
extend-exclude = ["localized/*.po"]

Integrations

• GitHub Actions
• pre-commit
• 🐊Putout Processor
• Visual Studio Code
• typos-lsp (Language Server Protocol server)

Custom

typos provides several building blocks for custom native integrations

• - reads from stdin, --write-changes will be written to stdout
• --diff to provide a diff
• --format json to get jsonlines with exit code 0 on no errors, code 2 on typos, anything else is an error.

Examples:

# Read file from stdin, write corrected version to stdout
typos - --write-changes
# Creates a diff of what would change
typos dir/file --diff
# Fully programmatic control
typos dir/file --format json

Debugging

You can see what the effective config looks like by running

typos --dump-config -

You can then see how typos is processing your project with

typos --files
typos --identifiers
typos --words

If you need to dig in more, you can enable debug logging with -v

FAQ

Why was ... not corrected?

Does the file show up in typos --files? If not, check your config with typos --dump-config -. The [files] table controls how we walk files. If you are using files.extend-exclude, are you running into #593? If you are using files.ignore-vcs = true, is the file in your .gitignore but git tracks it anyways? Prefer allowing the file explicitly (see #909).

Does the identifier show up in typos --identifiers or the word show up in typos --words? If not, it might be subject to one of typos' heuristics for detecting non-words (like hashes) or unambiguous words (like words after a \ escape).

📊 Community Health & Metrics

The weekly GitHub metrics track repository stars and forks, contributor activity, and issue and pull request activity. Definitions, snapshots, and collection details are linked below:

Resource	Description
Monthly Community Call Calendar	Recurring first-Tuesday call at 16:00 UTC, with calendar reminders
Community Call Archive	Searchable notes, recordings, transcripts, and follow-up actions
Project Showcase	10+ real production Stellar/Soroban projects built with the cookbook, with case studies and tracking
Ecosystem Partnerships	Partner projects, active collaborations, joint content, and the reciprocal cross-promotion model
Formal Partnership Proposal	Partnership qualification criteria, benefits, MOU agreement template, and onboarding roadmap
IDE & Tooling Integration	Shared VS Code setup (extensions, tasks, debug, Soroban snippets), IntelliJ/RustRover setup, linting and testing tools
Additional Wallet Support	Hana, LOBSTR, and Ledger adapter examples with tests, Stellar Wallets Kit, and a wallet comparison guide
Deployment Best Practices	Pre-deployment checklist, network selection, monitoring setup, and upgrade strategies
Featured Projects	First 5 projects featured, each with a case study, runnable demo, developer interview, and promotion plan
Project Templates	Full-stack starter templates for Fungible Token, NFT Marketplace, and DAO dApps
Bug Bounty Program	Active responsible-disclosure program, scope, rewards, and private reporting channel
Bug Bounty Launch Kit	Announcement draft, outreach plan, and launch record
Community Dashboard	Weekly snapshots of stars, forks, contributors, issues, PRs, and response times
Documentation Metrics	Page views, search queries, popular content, and user path analysis
Metric Definitions	What we measure, how we collect it, and alert thresholds
Recognition System	How contribution activity earns contributor tier badges
Iterable Mapping	Canonical enumeration pattern for key-value maps using a side list, with keys(page) and values(page) pagination helpers

The dashboards are updated automatically every Monday by GitHub Actions workflows.

🗣️ Office Hours

Recurring community office hours for questions, troubleshooting, and pairing on contributions.

Detail	Info
Schedule	Biweekly, every other Thursday at 16:00 UTC (60 minutes)
Platform	Stellar Discord voice channel (join link posted in GitHub Discussions)
Calendar	Subscribe to the office hours calendar invite
Promotion	Announced via GitHub Discussions, Discord, and social channels one week ahead
Format	Short topic/agenda intro, open Q&A, and a rotating deep-dive topic each session
Notes & Recordings	Office Hours wiki — agenda, notes, and video archive

Have a question you'd like covered? Open a thread in GitHub Discussions or drop it in the agenda before the session.

Community Health

Community health reports will be published quarterly using the report template. They cover participation, responsiveness, project trends, and follow-up actions, compare results with previous periods, and use aggregate public data to protect contributor privacy.

Additional Resources

If it is showing up, likely typos doesn't know about it yet.

typos maintains a list of known typo corrections to keep the false positive count low so it can safely run unassisted.

This is in contrast to most spell checking UIs people use where there is a known list of valid words. In this case, the spell checker tries to guess your intent by finding the closest-looking word. It then has a gauge for when a word isn't close enough and assumes you know best. The user has the opportunity to verify these corrections and explicitly allow or reject them.

For more on the trade offs of these approaches, see Design.

• To correct it locally, see also our False Positives documentation.
• To contribute your correction, see Contribute