Metadata-Version: 2.3
Name: hackbot
Version: 0.1.14
Summary: CLI tool for source code analysis using the Hackbot service
Author-email: Hugo Berg <hugo@gatlingx.com>
Requires-Python: >=3.11.9
Requires-Dist: aiohttp>=3.10.10
Requires-Dist: gitpython>=3.1.43
Requires-Dist: loguru>=0.7.2
Requires-Dist: pygithub>=2.5.0
Requires-Dist: termcolor>=2.5.0
Requires-Dist: tqdm>=4.67.0
Description-Content-Type: text/markdown

# Hackbot

CLI tool for source code analysis using the [GatlingX Hackbot](https://hackbot.org/) service.

## Installation

```bash
pip install hackbot
```

## Performing a scan
Execute the following command to perform a scan.
Visit your dashboard at [hackbot.org](https://hackbot.org/dashboard/api-keys/) 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.

```bash
cd your-project-directory
python -m hackbot --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.

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