repofy
v0.1.2
Published
CLI that analyzes a repository and outputs a structured Markdown explanation.
Maintainers
Readme
repofy
CLI that analyzes a repository and outputs a structured Markdown explanation.
Usage
repofy [path] [--md|--json] [--verbose|--quiet] [--config <path>] [--help] [--version]Configuration
Create a JSON config file and pass it via --config:
{
"output": "json",
"verbose": false,
"quiet": false
}repofy . --config .repofyrc.jsonDevelopment
npm run build
node dist/index.jsSmoke Test
npm run build
node bin/smoke-test.js [path]Manual checklist:
repofy .prints Markdown to stdout.repofy . --mdprints Markdown to stdout.repofy . --jsonprints valid JSON to stdout with no extra logs.repofy --helpprints usage to stdout.repofy --versionprints the version to stdout.repofy -Vprints the version to stdout.repofy . --quietprints only the final output (no logs).repofy . --config .repofyrc.jsonapplies config defaults.repofy /does/not/existprints a friendly error to stderr.repofy https://github.com/user/repoprints a friendly error to stderr.
