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>
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hackbot-0.1.16.3.tar.gz.
File metadata
- Download URL: hackbot-0.1.16.3.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8da7078cc098603939c194ca01fcb9d3bdd3f2efb4446b7bc14052cc14cf5c56
|
|
| MD5 |
508fd3c3ad96b7b937fdaf7a46bc9cc5
|
|
| BLAKE2b-256 |
ab05354f2c366338ee86475b586c7aa28496d7aacf3c4460286b2eb4a592bf6a
|
File details
Details for the file hackbot-0.1.16.3-py3-none-any.whl.
File metadata
- Download URL: hackbot-0.1.16.3-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17c3fb20f9092d736de72162af84151f9f3f5a31092d30ae2943f7a41806d090
|
|
| MD5 |
931ea9aab2a0a708ee37f799cb17f622
|
|
| BLAKE2b-256 |
83d8c38934c9a83efd4c897c7d371266247bef40f317ea1683b55f8b17daf492
|
