Metadata-Version: 2.4
Name: hound-cli
Version: 0.1.1
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.8.0
Dynamic: license-file

# Hound CLI

The command-line interface for managing [Hound](https://cyberhound.ai) penetration tests.

## Install

Requires Python 3.14 or newer and [`pipx`](https://pipx.pypa.io/stable/installation/).

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

To upgrade:

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

Hound uses your current AWS credentials to access your Hound environment.
Run `hound <command> --help` for usage and options, or see the reference below.

## Command reference

<!-- [[[cog
import click
import cog
from hound_cli.__main__ import main


def render(command, name, parent=None):
    with command.make_context(name, [], parent=parent, resilient_parsing=True, terminal_width=88) as ctx:
        cog.outl(f"### `{ctx.command_path}`\n\n```text\n{ctx.get_help()}\n```\n")
        if isinstance(command, click.Group):
            for child_name in command.list_commands(ctx):
                render(command.get_command(ctx, child_name), child_name, ctx)


render(main, "hound")
]]] -->
### `hound`

```text
Usage: hound [OPTIONS] COMMAND [ARGS]...

  Hound CLI.

Options:
  -h, --help  Show this message and exit.

Commands:
  agents       List Hound agents and their configured contact details.
  auth         Show and check DNS authorization for a target.
  engagements  Launch and manage penetration tests.
  inbox        Read recent agent email or SMS for this account.
  ips          List persistent Hound Elastic IPs.
  reports      Manage task-scoped customer report reviews.
  retests      Launch and manage retests.
  status       Show the account-wide work queue, newest first.
```

### `hound agents`

```text
Usage: hound agents [OPTIONS]

  List Hound agents and their configured contact details.

Options:
  -h, --help  Show this message and exit.
```

### `hound auth`

```text
Usage: hound auth [OPTIONS]

  Show and check DNS authorization for a target.

Options:
  --domain TEXT  Use this exact target domain.
  -h, --help     Show this message and exit.
```

### `hound engagements`

```text
Usage: hound engagements [OPTIONS] COMMAND [ARGS]...

  Launch and manage penetration tests.

Options:
  -h, --help  Show this message and exit.

Commands:
  launch  Start a new penetration test or relaunch a previous one.
  logs    View the log stream for an engagement.
  status  Show engagement status details.
  stop    Stop an engagement and wait for its infrastructure to be absent.
```

### `hound engagements launch`

```text
Usage: hound engagements launch [OPTIONS]

  Start a new penetration test or relaunch a previous one.

Options:
  --skip-dns-check  Skip live DNS authorization checks after confirming authorization
                    out of band.
  --domain TEXT     Use this exact target domain.
  -h, --help        Show this message and exit.
```

### `hound engagements logs`

```text
Usage: hound engagements logs [OPTIONS]

  View the log stream for an engagement.

Options:
  -t, --tail      Keep polling for new events.
  --domain TEXT   Use this exact target domain.
  --task-id TEXT  Use one exact task; requires --domain.
  -h, --help      Show this message and exit.
```

### `hound engagements status`

```text
Usage: hound engagements status [OPTIONS]

  Show engagement status details.

Options:
  --task-id TEXT  Show one exact task; requires --domain.
  --domain TEXT   Filter by exact target domain.
  -h, --help      Show this message and exit.
```

### `hound engagements stop`

```text
Usage: hound engagements stop [OPTIONS]

  Stop an engagement and wait for its infrastructure to be absent.

Options:
  --task-id TEXT  Use one exact task; requires --domain.
  --domain TEXT   Use this exact target domain.
  -h, --help      Show this message and exit.
```

### `hound inbox`

```text
Usage: hound inbox [OPTIONS]

  Read recent agent email or SMS for this account.

Options:
  --agent TEXT           Stable agent ID from hound/agents.
  --channel [email|sms]  Inbox channel.
  --since TEXT           Recent window: 30m, 2h, or up to 7d.  [default: 24h]
  -h, --help             Show this message and exit.
```

### `hound ips`

```text
Usage: hound ips [OPTIONS]

  List persistent Hound Elastic IPs.

Options:
  -h, --help  Show this message and exit.
```

### `hound reports`

```text
Usage: hound reports [OPTIONS] COMMAND [ARGS]...

  Manage task-scoped customer report reviews.

Options:
  -h, --help  Show this message and exit.

Commands:
  close   Upload one reviewed task to S3 and wipe its local copy.
  open    Pull task artifacts for local review.
  render  Render one reviewed customer report package as a PDF.
```

### `hound reports close`

```text
Usage: hound reports close [OPTIONS]

  Upload one reviewed task to S3 and wipe its local copy.

Options:
  -h, --help  Show this message and exit.
```

### `hound reports open`

```text
Usage: hound reports open [OPTIONS]

  Pull task artifacts for local review.

Options:
  --domain TEXT   Use this exact target domain.
  --task-id TEXT  Use one exact task; requires --domain.
  -h, --help      Show this message and exit.
```

### `hound reports render`

```text
Usage: hound reports render [OPTIONS]

  Render one reviewed customer report package as a PDF.

Options:
  --customer-name TEXT  Customer or application name shown on the cover.
  -h, --help            Show this message and exit.
```

### `hound retests`

```text
Usage: hound retests [OPTIONS] COMMAND [ARGS]...

  Launch and manage retests.

Options:
  -h, --help  Show this message and exit.

Commands:
  launch  Start or relaunch a retest for a completed penetration test.
  logs    View the log stream for a retest.
  status  Show retest status details.
  stop    Stop a retest and wait for its infrastructure to be absent.
```

### `hound retests launch`

```text
Usage: hound retests launch [OPTIONS]

  Start or relaunch a retest for a completed penetration test.

Options:
  --skip-dns-check  Skip live DNS authorization checks after confirming authorization
                    out of band.
  --domain TEXT     Use this exact target domain.
  -h, --help        Show this message and exit.
```

### `hound retests logs`

```text
Usage: hound retests logs [OPTIONS]

  View the log stream for a retest.

Options:
  -t, --tail      Keep polling for new events.
  --domain TEXT   Use this exact target domain.
  --task-id TEXT  Use one exact task; requires --domain.
  -h, --help      Show this message and exit.
```

### `hound retests status`

```text
Usage: hound retests status [OPTIONS]

  Show retest status details.

Options:
  --task-id TEXT  Show one exact task; requires --domain.
  --domain TEXT   Filter by exact target domain.
  -h, --help      Show this message and exit.
```

### `hound retests stop`

```text
Usage: hound retests stop [OPTIONS]

  Stop a retest and wait for its infrastructure to be absent.

Options:
  --task-id TEXT  Use one exact task; requires --domain.
  --domain TEXT   Use this exact target domain.
  -h, --help      Show this message and exit.
```

### `hound status`

```text
Usage: hound status [OPTIONS]

  Show the account-wide work queue, newest first.

Options:
  --task-id TEXT  Show one exact task; requires --domain.
  --domain TEXT   Filter by exact target domain.
  -h, --help      Show this message and exit.
```

<!-- [[[end]]] -->

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