monkcli

CLI typing test inspired by Monkeytype.

Requirements

• Node.js 20+
• npm

Install

npm

npm install -g @siddhaartha_bs/monkcli
monkcli

If your npm global install tries to write to a system directory and asks for sudo, prefer a user-local npm prefix instead of installing with elevated privileges:

mkdir -p "$HOME/.local"
npm config set prefix "$HOME/.local"
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Then install again:

npm install -g @siddhaartha_bs/monkcli

npx

npx @siddhaartha_bs/monkcli

Upgrade

npm install -g @siddhaartha_bs/monkcli@latest

@latest means the latest version published to npm, not the latest local commits on main.

Check Version

Check the installed CLI version:

monkcli --version

Check the latest published npm version:

npm view @siddhaartha_bs/monkcli version

Uninstall

npm uninstall -g @siddhaartha_bs/monkcli

Source Development

npm install
npm run build
node ./bin/monkcli.mjs

For interactive local development without a full rebuild:

npm run dev

If monkcli Is Not Found

This is usually a PATH issue with your npm global bin directory.

npm prefix -g

Make sure the corresponding bin directory is on your PATH:

• Linux: $(npm prefix -g)/bin
• macOS: $(npm prefix -g)/bin
• Windows: the prefix directory reported by npm prefix -g

Where Data Is Stored

monkcli writes three files:

• results.json (test history)
• stats.json (running totals + average WPM/accuracy)
• settings.json (saved language/mode/options)

Default locations:

• Linux:
  • results/stats: ~/.local/state/monkcli/
  • settings: ~/.config/monkcli/
• macOS:
  • results/stats/settings: ~/Library/Application Support/monkcli/
• Windows:
  • results/stats: %LOCALAPPDATA%\\monkcli\\
  • settings: %APPDATA%\\monkcli\\

Overrides:

• MONKCLI_DATA_DIR overrides results + stats directory.
• MONKCLI_CONFIG_DIR overrides settings directory.

Docker (Optional)

docker build -t monkcli:local .
docker run --rm -it monkcli:local