https://github.com/hexlet/languagetool-cli
CLI for spell checking
https://github.com/hexlet/languagetool-cli
Last synced: 12 months ago
JSON representation
CLI for spell checking
- Host: GitHub
- URL: https://github.com/hexlet/languagetool-cli
- Owner: Hexlet
- Created: 2023-12-08T20:36:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-07T15:27:21.000Z (over 1 year ago)
- Last Synced: 2025-04-05T14:51:10.517Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# languagetool-cli
## Checking errors
```bash
docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check
```
Example:
```bash
docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check /content/**/*.md
```
Help:
```bash
docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js check -h
Usage: run check [options] [dir_path]
Fix errors with overwriting files
Arguments:
dir_path path to files (default: "/content")
Options:
-r, --rules "rule1, rule2, ..." languagetools rules
-l, --language A language code like en-US, de-DE, fr, or
auto to guess the language automatically
(default: "auto")
-i, --ignore Path to file with ignore contexts (default:
"/content/ignored_languagetool_errors")
-h, --help display help for command
```
## Fixing errors:
```bash
docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix
```
Example:
```bash
docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix /content/**/*.md
```
Help:
```bash
docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js fix -h
Usage: run fix [options]
Options:
-r, --rules "rule1, rule2, ..." languagetools rules
-l, --language A language code like en-US, de-DE, fr, or
auto to guess the language automatically
(default: "auto")
-h, --help display help for command
```
## To get wrong words:
```bash
docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words
```
Example:
```bash
docker run --rm -v ./fixtures:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words /content/**/*.md
```
```bash
docker run --rm -v ./:/content ghcr.io/hexlet/languagetool-cli node ./bin/run.js words -h
Options:
-r, --rules "rule1, rule2, ..." languagetools rules
-l, --language A language code like en-US, de-DE, fr, or
auto to guess the language automatically
(default: "auto")
-f, --file Destination (default: "wrong_words.txt")
-h, --help display help for command
```