regain
v0.0.3
Published
Regain control over your source code
Downloads
6
Readme
regain
Regain control over your source code. This cli tool allow you to generate project birdview, documentation, statistics, control technical dept. All of that with a few simple queries using Regain DSL.
Regain CLI:
- Regain Crawler (parses source code and folder structure and saves it to JSON)
- Regain DSL (query language for JSON)
- Regain Templates (templates for documentation and eslint plugins)
This tools is bases on awesome projects:
- Discovery (https://github.com/discoveryjs/discovery)
- Jora (https://github.com/lahmatiy/jora)
Usage
$ npm install -g regain
$ regain COMMAND
running command...
$ regain (-v|--version|version)
regain/0.0.3 darwin-x64 node-v11.3.0
$ regain --help [COMMAND]
USAGE
$ regain COMMAND
...
Commands
regain help [COMMAND]
display help for regain
USAGE
$ regain help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
regain init [FILE]
generates initial files for documentation
USAGE
$ regain init [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-t, --type=type type of template (one of "discovery", "angular", "react", "vue", "eslint-plugin")
See code: src/commands/init.ts