https://github.com/withfig/cli-help-parser
Generate completion specs based on --help text
https://github.com/withfig/cli-help-parser
Last synced: 5 months ago
JSON representation
Generate completion specs based on --help text
- Host: GitHub
- URL: https://github.com/withfig/cli-help-parser
- Owner: withfig
- Created: 2020-12-23T19:23:20.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-19T02:15:35.000Z (almost 5 years ago)
- Last Synced: 2025-04-05T11:34:27.874Z (9 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cli-help-parser
### Legacy script usage:
The scripts need to be tweaked and modified in order to work with new CLI tools.
Steps:
1. Update `root` or `rootName` variable in each script to the name of the CLI tool (eg. docker)
2. Create a folder with the same name as the CLI tool / `root`
3. `node scraper.js`
Attempts to scrape help text for all subcommands - there can be false positive. Will create a new file for each subcommand in the `root` folder.
Format is `command.subcommand1.subcommand2.txt`
You can set the recursion depth by updating the `maxDepth` variable.
4. `node parser.js`
Looks in the `root` folder and builds a file named `root`-master.json. This is where the regexes are defined; they may need to be tweaked based on --help format.
5. `node converter.js`
Takes the `root`-master.json and converts it into the final `root`.js file.
----
I am planning on bundling these into a single tool and parameterizing the settings. This is temporary!