Skip to main content

CLI tool for source code analysis using the Hackbot service

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Hackbot

CLI tool for source code analysis using the GatlingX Hackbot service.

Installation

pip install hackbot

Performing a scan

Execute the following command to perform a scan. Visit your dashboard at hackbot.co to retrieve your API key. Either set the API key as an environment variable HACKBOT_API_KEY or pass it as an argument to the command line tool.

cd your-project-directory
python -m hackbot run --api-key <api-key>

You will then see various messages and results in the terminal. If --output is provided, the complete output will also be written to a JSON file. At the end of the scan, you will get a link to the dashboard where you can view the results.

CLI options

See python -m hackbot --help for more information

Generating issues

This module can generate issues in a GitHub repository. To do this, you will need to provide a GitHub API key with write issue access to the repository you want to report the issues to (--issues_repo). The scan will generate an issue with the title HB-<number>, where <number> is automatically generated, and will add the discovered bugs as comments to this issue.

python -m hackbot run --api-key <api-key> --issues_repo <owner>/<repo> --github_api_key <github-api-key>

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hackbot-0.1.15.18.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hackbot-0.1.15.18-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file hackbot-0.1.15.18.tar.gz.

File metadata

  • Download URL: hackbot-0.1.15.18.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for hackbot-0.1.15.18.tar.gz
Algorithm Hash digest
SHA256 c84e51e0ab5347b120564440113d91661538891dffe5169d910d20f2b799ff01
MD5 d3661079af3659bb34437af19b1e3d1d
BLAKE2b-256 38f2807d4044c67b124180aa06de66a8bc9eeec30d338aab4439544766b18821

See more details on using hashes here.

File details

Details for the file hackbot-0.1.15.18-py3-none-any.whl.

File metadata

  • Download URL: hackbot-0.1.15.18-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for hackbot-0.1.15.18-py3-none-any.whl
Algorithm Hash digest
SHA256 020976f2f70c9f4fd879675b66aa5e78bba410b590d2958870ad4132262df9fa
MD5 0adcc1cec35fa21953d9195a25f33876
BLAKE2b-256 de6026cb602234cd4e47195e3d894ec64896963599cf51ddfa508ec7327152d6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page