SYNOPSIS
codespell [OPTIONS] [file1 file2 ... fileN]DESCRIPTION
codespell is designed to find and fix common misspellings in text files. It is designed primarily for checking misspelled words in source code, but it can be used with other files as well.
OPTIONS
- --version
- show program's version number and exit
- -h, --help
- show this help message and exit
- -d, --disable-colors
- Disable colors even when printing to terminal
- -c, --enable-colors
- Enable colors even when not printing to terminal
- -w, --write-changes
- write changes in place if possible
- -D FILE, --dictionary=,FILE/
- Custom dictionary file that contains spelling corrections. If this flag is not specified then default dictionary "/usr/share/codespell/dictionary.txt" is used.
- -s, --summary
- print summary of fixes
- -S SKIP, --skip=,SKIP/
- Comma-separated list of files to skip. It accepts globs as well. E.g.: if you want codespell to skip .eps and .txt files, you'd give "*.eps,*.txt" to this option.
- -x FILE, --exclude-file=,FILE/
- FILE with lines that should not be changed
- -i INTERACTIVE, --interactive=,INTERACTIVE/
- Set interactive mode when writing changes. 0 is the same of no interactivity; 1 makes codespell ask confirmation; 2 ask user to choose one fix when more than one is available; 3 applies both 1 and 2
- -q QUIET_LEVEL, --quiet-level=,QUIET_LEVEL/
- Bitmask that allows codespell to run quietly. 0: the default, in which all messages are printed. 1: disable warnings about wrong encoding. 2: disable warnings about binary file. 4: shut down warnings about automatic fixes that were disabled in dictionary. 8: don't print anything for non-automatic fixes. 16: don't print fixed files.
- -e, --hard-encoding-detection
- Use chardet to detect the encoding of each file. This can slow down codespell, but is more reliable in detecting encodings other than utf-8, iso8859-1 and ascii.