# Proxbox CLI

`proxbox_cli` is the command-line client for the `proxbox-api` backend that powers the Proxbox NetBox plugin workflows.

It is a Typer application with top-level operational commands plus grouped command trees for:

- `netbox`
- `proxmox`
- `dcim`
- `virtualization`
- `extras`
- `sync-processes`

## Installation

Install the CLI dependencies from this repository checkout:

```bash
pip install "netbox-proxbox[cli]"
```

After installation, the console entrypoint is:

```bash
pxb --help
```

## Configuration

Initialize the CLI once so it knows where `proxbox-api` is running:

```bash
pxb init
pxb config
pxb test
```

The CLI stores its config under `~/.config/proxbox-cli/config.json` unless `XDG_CONFIG_HOME` overrides that path.

## Generated Reference

The MkDocs site includes two machine-generated CLI sections:

- [Command Reference](../reference/proxbox-cli/command-catalog/index.md) lists every discovered command and an autogenerated example invocation.
- [Command Examples](../reference/proxbox-cli/command-examples/index.md) captures representative help output for major command groups and leaf commands.

## Regeneration

To refresh the generated CLI docs from the current checkout:

```bash
python docs/generate_proxbox_cli_docs.py
```

The CLI exposes the same generator directly:

```bash
pxb docs generate-capture
```
