Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

Hackbot has been discontinued, this project is no longer maintained

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.

Learning from Security Resources

Hackbot also supports a learn command that allows it to update its checklist based on external resources. For example, to learn from a blog post, run:

python -m hackbot learn --url https://blog.openzeppelin.com/web3-security-auditors-2024-rewind

This command will fetch additional checklist data to enhance Hackbot's analysis.

CLI options

See python -m hackbot --help for more information

Metadata

Release files for hackbot 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hackbot 0.3.0
File Size Uploaded Provenance Actions
hackbot-0.3.0.tar.gz 26.8 kB Without provenance Details for hackbot-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hackbot 0.3.0
File Interpreter ABI Platform Actions
hackbot-0.3.0-py3-none-any.whl Python 3 none any Details for hackbot-0.3.0-py3-none-any.whl

Total release size: 49.6 kB

Release files / hackbot-0.3.0.tar.gz

Download URL hackbot-0.3.0.tar.gz
Size 26.8 kB
Tags Source
SHA-256 checksum
How to use checksums
52a13bc6aa020a0eb6a6e41fe960a8b7ed02ad93fc697fea94abe2f333aed51b
BLAKE2b-256 checksum
How to use checksums
fcca9652c47781d273315e538eabefbbfaa3597fceed1bee1342a721ad749ce7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.9

Release files / hackbot-0.3.0-py3-none-any.whl

Download URL hackbot-0.3.0-py3-none-any.whl
Size 22.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ff38a50ea6e9d0b4693fc5aac2b4f1a40a7d743d051244b9496481ae32607367
BLAKE2b-256 checksum
How to use checksums
730a57cbe2e21b0e72d469f26f0028ded991880b91ea4f535fa840faf91d3eb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.9

Security for hackbot 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page