CLI
The tarask command runs the prebuilt Rust binary for your platform — the
same converter as the JS API, but faster, and able to stream multi-GB inputs
with parallel processing. Its flags map onto
TaraskConfig options.
Install via npm
Section titled “Install via npm”Installing the package also installs the tarask command. The binary
matching your platform is downloaded automatically from
GitHub releases on install (or, failing that, on first run).
npm install -g taraskevizer# oryarn global add taraskevizer# orbun add -g taraskevizerIf the binary cannot be downloaded (offline install, --ignore-scripts),
download the asset for your platform manually (see below) and place it into
<package>/dist/bin/. Set TARASKEVIZER_SKIP_BINARY_DOWNLOAD=1 to skip
the download.
Native binaries (no runtime needed)
Section titled “Native binaries (no runtime needed)”Every release ships standalone tarask executables for these platforms:
| OS | Architecture | Asset |
|---|---|---|
| Linux | x64 | tarask-x86_64-unknown-linux-gnu |
| Linux | ARM64 | tarask-aarch64-unknown-linux-gnu |
| macOS | x64 (Intel) | tarask-x86_64-apple-darwin |
| macOS | ARM64 (Apple Silicon) | tarask-aarch64-apple-darwin |
| Windows | x64 | tarask-x86_64-pc-windows-msvc.exe |
Download the file from GitHub releases, make it executable (not needed on Windows) and run it:
chmod +x tarask-x86_64-unknown-linux-gnu./tarask-x86_64-unknown-linux-gnu --latin 'планета'tarask [options] textFor the full option list, run tarask --help.
Without installation
Section titled “Without installation”npx taraskevizer [options] text# orbunx taraskevizer [options] textExamples
Section titled “Examples”Convert and latinize a word:
tarask --latin 'планета'# p{\fix l}a{\fix ne}taRead from a file and write the converted text to another:
tarask < ./cyr-text.txt > ./lat-text.txtInteractive mode (no text argument) — prompts for input line by line:
tarask# Enter the text:Options
Section titled “Options”General
Section titled “General”| Flag | Description |
|---|---|
-h, --help |
Show help |
-v, --version |
Show version |
Alphabet
Section titled “Alphabet”| Flag | Description |
|---|---|
-l, --latin |
Use the Latin alphabet |
-lj, --latin-ji |
Use the Latin alphabet with і/ј |
-a, --arabic |
Use the Arabic alphabet |
When to replace і(i) by й(j) after vowels
Section titled “When to replace і(i) by й(j) after vowels”| Flag | Description |
|---|---|
-jr, --jrandom |
Random |
-ja, --jalways |
Always |
Replace ґ(g) by г(h) in the Cyrillic alphabet
Section titled “Replace ґ(g) by г(h) in the Cyrillic alphabet”| Flag | Description |
|---|---|
--h |
Use г instead of ґ |
Variations
Section titled “Variations”| Flag | Description |
|---|---|
-nv, --no-variations |
Use the main spelling |
-fv, --first-variation |
Use the first variation |
Mode (only one may be used)
Section titled “Mode (only one may be used)”| Flag | Description |
|---|---|
-html, --html |
HTML mode (emit tarF/tarL/tarH tags) |
-abc, --alphabet-only |
Alphabet-only conversion |
-ph, --phonetic |
Phonetic conversion |
| Flag | Description |
|---|---|
-nec, --no-escape-caps (--not-escape-caps) |
Don’t protect capitalized runs |
-nc, --no-color |
Disable ANSI color wrapping |
-st, --single-thread |
Force single-threaded execution |
Known bugs
Section titled “Known bugs”Replacing не with ня
Section titled “Replacing не with ня”Ня should appear before a word where the first syllable is stressed.
At the moment there is no reliable way to check whether it is stressed.
The algorithm applies heuristics, but they do not cover all cases.