https://github.com/paceaux/methodius-cli
Methodius CLI
https://github.com/paceaux/methodius-cli
Last synced: 5 months ago
JSON representation
Methodius CLI
- Host: GitHub
- URL: https://github.com/paceaux/methodius-cli
- Owner: paceaux
- License: other
- Created: 2024-03-28T03:40:21.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-27T18:34:27.000Z (almost 2 years ago)
- Last Synced: 2025-10-06T22:54:48.588Z (8 months ago)
- Language: JavaScript
- Size: 1.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Methodius CLI (an N-gram utility)
Methodius A utility for analyzing frequency of text in chunks.
This CLI lets you do it from the command line.
[](https://firstdonoharm.dev/version/3/0/law-media-mil-soc-sv.html)
## Installation
### Prerequisites
- Node LTS (as of September 2023, Node 18.16.0)
### Running on-demand
Download this package. Then run
```shell
npm install
```
### Globally via NPM
```shell
npm i -g methodius-cli
```
## Usage
### Basic Scanning
Get all the details:
```shell
methodius -f "great-expectations.txt"
```
Decide what properties you'd like to see:
(use `-p` for each property you want to see)
```shell
methodius -f "great-expectations.txt" -p "uniqueWords" -p "uniqueBigrams" -p letterFrequencies
```
Do the same on multiple files
```shell
methodius -f "great-expectations.txt" -f "a-tale-of-two-cities.txt" -p "uniqueWords" -p "uniqueBigrams" -p letterFrequencies
```
Output multiple files to a directory
```shell
methodius -f "great-expectations.txt" -f "a-tale-of-two-cities.txt" -p "uniqueWords" -p "uniqueBigrams" -p letterFrequencies -o "dickens/"
```
Set your own output file
```shell
methodius -f "great-expectations.txt" -f "a-tale-of-two-cities.txt" -p "uniqueWords" -o uniqueWords.json
```
### Options
| Option | Alias | Description | Defaults |
|---|---|---|---|
| `--files` |`-f` | fully qualified path to a file Required. | `samples/alice.txt` |
| `--topLimit` |`-l` | for any methods, this sets the number of top-ngrams to get. Optional. | `15` |
| `--properties` | `-p` | which properties to return. Optional. Get the list off of the [repo](https://github.com/paceaux/methodius) | `'bigramFrequencies','trigramFrequencies','letterFrequencies','meanWordSize', 'medianWordSize','wordFrequencies','bigramPositions','trigramPositions', 'uniqueWords'` |
| `--topMethods` | `-s` | which "top" methods to use. optional. | `'topBigrams', 'topTrigrams','topWords',`|
| `--outputFileName` | `-o` | name of the output file. Optional. | `analysis.json` or `.analysis.json` if multiple files. This could also be a directory: `analysis/en/` |
| `--mergeResults`| `-m` | Merges the results files. output will be `.merged.json` . Optional. | `false`|
#### Merging results
`--mergeResults`, `-m`, and `methodius-merge` analyzes all of the results files and creates a single file that contains all of the results. How it merges is based on the type of value for the property:
- If a property in a results file is an Object or a Map, what's merged are the keys. Duplicates are removed.
- If a property in a results file is an array or Set (which would be weird because JSON can't output a Set), the arrays are concatenated. Duplicates are removed.
- If a property in a results file is a number, the numbers are averaged.
##### Merging results with `methodius-merge`
If you want to merge results after the fact, you can use the `methodius-merge` command. This takes all of the same arguments as `methodius`. It exists so that there's the option to pick the files you merge.
```shell
methodius-merge -f "alice.analysis.json" "huck-fin.analysis.json" -o "merged.json"
```
You can also designate which properties from the analysis files you want to merge:
```shell
methodius-merge -f "alice.analysis.json" "huck-fin.analysis.json" -o "merged.json" -p uniqueWords
```