CLI that analyzes a repository and outputs a structured Markdown explanation.
npm install repofyCLI that analyzes a repository and outputs a structured Markdown explanation.
```
repofy [path] [--md|--json] [--verbose|--quiet] [--config
Create a JSON config file and pass it via --config:
``
{
"output": "json",
"verbose": false,
"quiet": false
}
``
repofy . --config .repofyrc.json
``
npm run build
node dist/index.js
``
npm run build
node bin/smoke-test.js [path]
Manual checklist:
- repofy . prints Markdown to stdout.repofy . --md
- prints Markdown to stdout.repofy . --json
- prints valid JSON to stdout with no extra logs.repofy --help
- prints usage to stdout.repofy --version
- prints the version to stdout.repofy -V
- prints the version to stdout.repofy . --quiet
- prints only the final output (no logs).repofy . --config .repofyrc.json
- applies config defaults.repofy /does/not/exist
- prints a friendly error to stderr.repofy https://github.com/user/repo` prints a friendly error to stderr.
-