GitRevue CLI

GitRevue CLI helps you report your asset information for review.

Installing

npm install -g @gitrevue/cli

Usage

You'll need an API key which you can create at https://app.gitrevue.io/settings#/api. Set the GITREVUE_TOKEN environment variable with your new API key.

Publishing artifacts

Publishing artifact information to GitRevue for comparison. You may supply as many globs as needed, any type of artifact may be published. You can use the --dry-run option to check matches without publishing them to the GitRevue API.

gitrevue artifacts <glob> [glob]

Developing

To develop @gitrevue/cli you'll need node 10+, if you have nvm installed you can run nvm use to select the correct node version.

Run npm run build to compile the library, then run npm link, this will symlink your development version to your global node modules. Now you can run the gitrevue command to test any changes you've made. You can also use npm run build:watch to watch for file changes and compile automatically.

You may run the test suite using npm test. Alternatively you can use npm run test:watch to watch for file changes and automatically rerun the test suite.

Releasing

1. Update version numbers in CHANGELOG.md and commit.
2. Run npm version to bump the package.json version, automatically commit and tag.
3. Next push the commits and tag using git push && git push --tags
4. Publish the new version with npm publish
5. Update the release on GitHub with the changes from CHANGELOG.md

License

MIT