@hawk1430/word-cli
v1.0.1
Published
A CLI tool to count word frequency in a file
Downloads
178
Readme
@hawk1430/word-cli
A lightweight Node.js CLI tool to count word frequency in a text file. It can either display the frequency of all words or return the count of a specific word.
Features
- Counts frequency of all words in a file
- Searches for a specific word and returns its count
- Works with any plain text file
- Built using modern Node.js (ES Modules)
- Simple, fast, and dependency-free
Installation
Install globally using npm:
npm install -g @hawk1430/word-cli
Usage
Count all words in a file
hawk-word-cli
Example:
hawk-word-cli ./sample.txt
Output:
{ "hello": 3, "world": 2, "node": 1 }
Count a specific word
hawk-word-cli
Example:
hawk-word-cli ./sample.txt hello
Output:
3
If the word is not found:
The word is not present in the given file
CLI Help
If the file path is missing:
✖ Usage: word-cli [word]
How It Works
- Reads the file using fs/promises
- Splits content using non-word characters (/\W+/)
- Stores word frequencies using a Map
- Outputs either:
- A full word-frequency object, or
- The count of a specific word
Requirements
- Node.js v18 or later
- npm installed
Author
Prashant Raj
License
This project is licensed under the MIT License.
