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.17.tar.gz (13.7 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.17-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hackbot-0.1.15.17.tar.gz
  • Upload date:
  • Size: 13.7 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.17.tar.gz
Algorithm Hash digest
SHA256 c301905b54d9e0ca8770a6b63978c63383ef121ae38d92b5c4eb3120281b6ed4
MD5 d90965bec4fdd7b3fc22949ed686dc38
BLAKE2b-256 de2da1d3686c491be35bf0942d464bbfa21f46d4d8143f92d03a3ce509463b58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hackbot-0.1.15.17-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 8cc8468c0eb5f4b0272eed2a2278fe350bbeec30bbea410164a5f372cfb7a643
MD5 42cbb87d12697a7abc9e544836f9e752
BLAKE2b-256 00a0c9ea08d1efe0afc5e56a21b3b725eeb7c5db97776d1bb368e238fa479906

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