CvssCli

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/cvss_cli. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add cvss_cli

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install cvss_cli

CvssCli needs a working directory to persist cvss strings between multiple invocations. Set the environment variable CVSS_CLI_PATH, e.g. via

$ echo "export CVSS_CLI_PATH=\"$HOME/.cvss_cli\"" >> ~/.bashrc

The cvss3_1.yaml containing all the metrics, their descriptions, etc. also needs to be placed there, so copy it into this folder.

Usage

See cvss help for more information.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cvss_cli.

License

The gem is available as open source under the terms of the MIT License.