@sumeetghimire/proof-cli
v1.0.1
Published
Install PRoof GitHub Action with one command
Downloads
27
Maintainers
Readme
proof-cli
proof-cli lets you install PRoof (the GitHub Action that verifies pull requests) with a single command—no copying YAML by hand.
Install PRoof in one command
npx @sumeetghimire/proof-cli initAnswer a few prompts; the CLI creates .github/workflows/proof.yml and you're done. Every PR will be verified by PRoof.
Commands
| Command | Description |
|--------|-------------|
| npx @sumeetghimire/proof-cli init | Install PRoof in this repo (creates the workflow file) |
| npx @sumeetghimire/proof-cli status | Show whether PRoof is installed and current config |
| npx @sumeetghimire/proof-cli update | Update PRoof to the latest version in the workflow file |
| npx @sumeetghimire/proof-cli remove | Remove PRoof (deletes the workflow file) |
Requirements
- Node.js 18+
- A git repository (run from your repo root)
What gets installed
The CLI creates .github/workflows/proof.yml that runs sumeetghimire/proof on every pull request. You choose options during init (e.g. block merge on failure, run tests, security scan, dependency checks).
Examples
# From your project root
npx @sumeetghimire/proof-cli init
npx @sumeetghimire/proof-cli status
npx @sumeetghimire/proof-cli update
npx @sumeetghimire/proof-cli removeLinks
- PRoof (the action): https://github.com/sumeetghimire/proof
- proof-cli (this repo): https://github.com/sumeetghimire/proof-cli
License
MIT
