{"id":42186597,"url":"https://github.com/paceaux/methodius-cli","last_synced_at":"2026-01-26T22:27:44.184Z","repository":{"id":230147184,"uuid":"778612205","full_name":"paceaux/methodius-cli","owner":"paceaux","description":"Methodius CLI","archived":false,"fork":false,"pushed_at":"2024-06-27T18:34:27.000Z","size":1370,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-10-06T22:54:48.588Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paceaux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-28T03:40:21.000Z","updated_at":"2024-06-27T18:32:23.000Z","dependencies_parsed_at":"2024-03-28T05:22:15.584Z","dependency_job_id":"6c78250c-208d-4bd4-90ac-69cf9f3e1b59","html_url":"https://github.com/paceaux/methodius-cli","commit_stats":null,"previous_names":["paceaux/methodius-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/paceaux/methodius-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paceaux%2Fmethodius-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paceaux%2Fmethodius-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paceaux%2Fmethodius-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paceaux%2Fmethodius-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paceaux","download_url":"https://codeload.github.com/paceaux/methodius-cli/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paceaux%2Fmethodius-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28789738,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-26T22:27:44.077Z","updated_at":"2026-01-26T22:27:44.158Z","avatar_url":"https://github.com/paceaux.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Methodius CLI (an N-gram utility)\n\nMethodius A utility for analyzing frequency of text in chunks.\n\nThis CLI lets you do it from the command line.\n\n[![Hippocratic License HL3-LAW-MEDIA-MIL-SOC-SV](https://img.shields.io/static/v1?label=Hippocratic%20License\u0026message=HL3-LAW-MEDIA-MIL-SOC-SV\u0026labelColor=5e2751\u0026color=bc8c3d)](https://firstdonoharm.dev/version/3/0/law-media-mil-soc-sv.html)\n\n![npm](https://img.shields.io/npm/dm/methodius-cli)\n\n## Installation\n\n### Prerequisites\n\n- Node LTS (as of September 2023, Node 18.16.0)\n\n\n### Running on-demand\n\nDownload this package. Then run\n\n```shell\nnpm install\n```\n\n### Globally via NPM\n\n```shell\nnpm i -g methodius-cli\n```\n\n## Usage\n\n### Basic Scanning\n\nGet all the details:\n\n```shell\nmethodius -f \"great-expectations.txt\"\n```\n\nDecide what properties you'd like to see:\n(use `-p` for each property you want to see)\n\n```shell\nmethodius -f \"great-expectations.txt\" -p \"uniqueWords\" -p \"uniqueBigrams\" -p letterFrequencies\n```\n\nDo the same on multiple files\n\n```shell\nmethodius -f \"great-expectations.txt\" -f \"a-tale-of-two-cities.txt\" -p \"uniqueWords\" -p \"uniqueBigrams\" -p letterFrequencies\n```\n\nOutput multiple files to a directory\n\n```shell\nmethodius -f \"great-expectations.txt\" -f \"a-tale-of-two-cities.txt\" -p \"uniqueWords\" -p \"uniqueBigrams\" -p letterFrequencies -o \"dickens/\"\n```\n\nSet your own output file\n\n```shell\nmethodius -f \"great-expectations.txt\" -f \"a-tale-of-two-cities.txt\" -p \"uniqueWords\" -o uniqueWords.json \n```\n\n\n### Options\n\n| Option | Alias | Description   | Defaults  |\n|---|---|---|---|\n| `--files` |`-f`  | fully qualified path to a file Required. | `samples/alice.txt` |\n| `--topLimit` |`-l`  | for any methods, this sets the number of top-ngrams to get. Optional. | `15` |\n| `--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'` |\n| `--topMethods` | `-s`  |  which \"top\" methods to use. optional. |  `'topBigrams', 'topTrigrams','topWords',`|\n| `--outputFileName` | `-o`  | name of the output file. Optional. | `analysis.json` or `\u003cinputfilename\u003e.analysis.json` if multiple files. This could also be a directory: `analysis/en/`  |\n| `--mergeResults`| `-m`  | Merges the results files. output will be `.merged.json` . Optional. | `false`|\n\n#### Merging results\n\n`--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:\n\n- If a property in a results file is an Object or a Map, what's merged are the keys. Duplicates are removed.\n- 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.\n- If a property in a results file is a number, the numbers are averaged.\n\n##### Merging results with `methodius-merge`\n\nIf 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.\n\n```shell\n\nmethodius-merge -f \"alice.analysis.json\" \"huck-fin.analysis.json\" -o \"merged.json\"\n```\n\nYou can also designate which properties from the analysis files you want to merge:\n\n```shell\nmethodius-merge -f \"alice.analysis.json\" \"huck-fin.analysis.json\" -o \"merged.json\" -p uniqueWords\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaceaux%2Fmethodius-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaceaux%2Fmethodius-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaceaux%2Fmethodius-cli/lists"}