### Install typos with Pacman

Source: https://github.com/crate-ci/typos/blob/master/README.md

Install the typos CLI using Pacman, the package manager for Arch Linux.

```bash
sudo pacman -S typos
```

--------------------------------

### Install typos with Homebrew

Source: https://github.com/crate-ci/typos/blob/master/README.md

Install the typos CLI using Homebrew, a popular package manager for macOS and Linux.

```bash
brew install typos-cli
```

--------------------------------

### Codespell Command Example

Source: https://github.com/crate-ci/typos/blob/master/benchsuite/runs/2019-10-29-Nightblood.md

This command demonstrates running codespell on the 'ripgrep_clean' fixture as part of the performance benchmark.

```bash
./codespell/bin/codespell ./ripgrep_clean
```

--------------------------------

### Install typos with Conda

Source: https://github.com/crate-ci/typos/blob/master/README.md

Install the typos CLI using Conda, a package and environment management system.

```bash
conda install typos
```

--------------------------------

### Misspell Go Command Example

Source: https://github.com/crate-ci/typos/blob/master/benchsuite/runs/2019-10-29-Nightblood.md

This command shows the execution of the misspell tool (Go implementation) against the 'ripgrep_clean' fixture.

```bash
./misspell_go/bin/misspell ./ripgrep_clean
```

--------------------------------

### Install typos with Cargo

Source: https://github.com/crate-ci/typos/blob/master/README.md

Install the typos CLI using Cargo, the Rust package manager. Ensure you use the --locked flag for reproducible builds.

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

--------------------------------

### Basic GitHub Action Setup

Source: https://github.com/crate-ci/typos/blob/master/docs/github-action.md

This snippet shows the basic configuration for a GitHub Action workflow that uses the Typos Action to perform a spell check on pull requests.

```yaml
name: Spelling

permissions:
  contents: read

on: [pull_request]

env:
  CLICOLOR: 1

jobs:
  spelling:
    name: Spell Check with Typos
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Actions Repository
      uses: actions/checkout@v5
    - name: Spell Check Repo
      uses: crate-ci/typos@v1.47.2
```

--------------------------------

### Typos CLI Command Example

Source: https://github.com/crate-ci/typos/blob/master/benchsuite/runs/2019-10-29-Nightblood.md

This command shows the execution of the typos-cli tool on the 'ripgrep_clean' fixture. It is part of the performance comparison.

```bash
./typos/bin/typos ./ripgrep_clean
```

--------------------------------

### Ripgrep Command Example

Source: https://github.com/crate-ci/typos/blob/master/benchsuite/runs/2019-10-29-Nightblood.md

This command demonstrates how ripgrep is used to search within the 'ripgrep_clean' fixture. It's included as a theoretical lower bound for performance.

```bash
./rg/rg bin ./ripgrep_clean
```

--------------------------------

### Code-generate Dictionary

Source: https://github.com/crate-ci/typos/blob/master/CONTRIBUTING.md

Run this command to code-generate the dictionary after adding new entries to `words.csv`. Ensure `cargo` and `rustfmt` are installed. This speeds up builds during development.

```bash
$ SNAPSHOTS=overwrite cargo test --workspace
```

--------------------------------

### Use a Custom Configuration File

Source: https://github.com/crate-ci/typos/blob/master/docs/github-action.md

Specify a custom configuration file using the `config` input to tailor the spell-checking behavior.

```yaml
name: Test GitHub Action
on: [pull_request]

jobs:
  run:
    name: Spell Check with Typos
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Actions Repository
      uses: actions/checkout@v5

    - name: Use custom config file
      uses: crate-ci/typos@v1.47.2
      with:
        files: ./file.txt
        config: ./myconfig.toml
```

--------------------------------

### TOML `default.extend-ignore-identifiers-re` Example

Source: https://github.com/crate-ci/typos/blob/master/docs/reference.md

Use regular expressions to specify always-valid identifiers. This example ignores identifiers with a length of 4 characters or less, treating them as potential noise.

```toml
[default]
extend-ignore-identifiers-re = [
    # identifiers with length <= 4 chars is likely noise
    "^[a-zA-Z]{1,4}$",
]
```

--------------------------------

### TOML `files.extend-exclude` Example

Source: https://github.com/crate-ci/typos/blob/master/docs/reference.md

Example of using `files.extend-exclude` to specify custom ignore globs. Note that the command-line arguments override this by default; use `--force-exclude` to ensure this setting is always respected.

```toml
[files]
extend-exclude = [
  "*",
  "!something",
]
```

--------------------------------

### TOML `default.extend-ignore-words-re` Example

Source: https://github.com/crate-ci/typos/blob/master/docs/reference.md

Use regular expressions to specify always-valid words. This example ignores words with a length of 4 characters or less, assuming they are likely noise. Remember to handle case insensitivity yourself.

```toml
[default]
extend-ignore-words-re = [
    # words with length <= 4 chars is likely noise
    "^[a-zA-Z]{1,4}$",
]
```

--------------------------------

### Get JSON output for programmatic control

Source: https://github.com/crate-ci/typos/blob/master/README.md

Use the `--format json` flag to get output in JSON lines format, which is useful for programmatic control and integration with other tools. The exit code indicates the presence of typos.

```bash
typos dir/file --format json
```

--------------------------------

### Run Benchsuite Script

Source: https://github.com/crate-ci/typos/blob/master/benchsuite/runs/2019-10-29-Nightblood.md

This command initiates the spell-checking benchmark suite. It takes the target directory and a specific run name as arguments.

```bash
$ ./benchsuite.sh . Nightblood
```