Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.25 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.25 KB

Threadfix

Command line tool that wraps the ThreadFix API

Installation

Install with:

$ gem install threadfix-cli

Usage

$ export THREADFIX_TOKEN=<API key>

$ threadfix applications lookup \
    --app-name <Application Name> \
    --team-name <Team Name> \
#=> <Application ID>

$ threadfix scan upload \
    --app-id <Application ID> \
    --host <Host Name> \
    --file ./repo/results.json
#=> <Upload Status>

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 tags, and push the .gem file to rubygems.org.

Using Docker

Build with:

docker build --rm -t threadfix-cli .

Run with:

docker run --rm -e THREADFIX_TOKEN -v `pwd`:/workspace threadfix-cli help

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/DDAZZA/threadfix-cli.