Forrest logo
back to context overview

codespell

List of commands for codespell:

  • codespell:tldr:13430 codespell: Print 3 lines of context around, before or after each match.
    $ codespell --${select} ${3}
    try on your machine
    explain this command
  • codespell:tldr:1feb2 codespell: Check for typos in all text files in the current directory, recursively.
    $ codespell
    try on your machine
    explain this command
  • codespell:tldr:26d32 codespell: Use a custom dictionary file when checking (`--dictionary` can be used multiple times).
    $ codespell --dictionary ${filename-txt}
    try on your machine
    explain this command
  • codespell:tldr:bb153 codespell: Do not check the specified words.
    $ codespell --ignore-words-list ${words,to,ignore}
    try on your machine
    explain this command
  • codespell:tldr:ccfb0 codespell: Check file names for typos, in addition to file contents.
    $ codespell --check-filenames
    try on your machine
    explain this command
  • codespell:tldr:cdd1b codespell: Do not check words that are listed in the specified file.
    $ codespell --ignore-words ${filename-txt}
    try on your machine
    explain this command
  • codespell:tldr:d475b codespell: Correct all typos found in-place.
    $ codespell --write-changes
    try on your machine
    explain this command
  • codespell:tldr:ffdf3 codespell: Skip files with names that match the specified pattern (accepts a comma-separated list of patterns using wildcards).
    $ codespell --skip "${pattern}"
    try on your machine
    explain this command
back to context overview