Metadata-Version: 2.4
Name: hound-cli
Version: 0.1.0
Summary: Hound operator CLI
License-Expression: Apache-2.0
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3>=1.35.0
Requires-Dist: click>=8.3.3
Requires-Dist: dnspython>=2.7
Requires-Dist: idna>=3.11
Requires-Dist: publicsuffixlist>=1.0.2.20260515
Requires-Dist: questionary>=2.1
Requires-Dist: urllib3>=2.7.0
Dynamic: license-file

# Hound CLI

The command-line interface for managing Hound penetration tests.

## Install

Requirements:

- Python 3.14 or newer.
- [`pipx`](https://pipx.pypa.io/stable/installation/) to install Hound.

Install Hound from PyPI:

```console
pipx install hound-cli
hound --help
```

To upgrade:

```console
pipx upgrade hound-cli
```

## Commands

Hound uses your current AWS credentials to access your Hound environment.

```text
hound agents
hound auth
hound ips
hound status
hound engagements launch|status|logs|stop
hound retests launch|status|logs|stop
hound inbox
hound reports open|render|close
```

Commands guide you through selection when context is needed. Run any command
with `--help` for additional options.

Launch commands collect or reuse the access details Hound needs, then check
target authorization before queueing work. `hound auth` shows the
accepted DNS record and its current status without starting a launch.

Interactive values, including passwords, remain visible while they are entered
and in subsequent summaries so the operator can verify them.

`hound status` opens the account work queue in a terminal pager, with the newest
work first and older history below it.
Stop requests continue in AWS if the local display is interrupted.

## Report review

`hound reports open` creates a local review, `render` produces a customer PDF,
and `close` uploads the local task files to S3 before wiping the local copy.
Files removed locally remain in S3. If an upload fails, the local review is
preserved. Reviews live under `~/Hound/reports` by default and may contain
sensitive customer data.

Hound CLI is licensed under the [Apache License 2.0](LICENSE).
