---
order: 2
summary: Command reference for the proxility workstation CLI and the connector binary.
title: CLI
path: reference/cli
status: published
---

# CLI

Two binaries. `proxility` is the workstation CLI that talks to the control
plane; `proxility-connector` is the service that runs inside a network.

## proxility

```
proxility login                         authenticate via ScaiKey
proxility realm use <tenant>/<realm>    set the working realm
proxility whoami                        show identity and roles
```

### Connectors

```
proxility connector create <name> [--description TEXT]
proxility connector list
proxility connector show <name>
proxility connector revoke <name>
proxility edge ranges                   current edge prefixes for allow-lists
```

### Services

```
proxility service create <name> --connector A[,B] --target HOST:PORT --protocol tcp|udp
proxility service list
proxility service show <name>
proxility service delete <name>
```

### Policy

```
proxility policy allow --from SELECTOR --to SERVICE --ports LIST
                       [--expires DATE] [--description TEXT]
proxility policy list [--expiring-within 30d]
proxility policy delete <rule-id>
proxility policy show --format yaml
proxility policy apply <file> [--dry-run]
proxility policy history
```

### Decision log

```
proxility log tail [--follow]
proxility log query --verdict deny --since 24h
```

## proxility-connector

Runs as a system service. The commands you use directly:

```
proxility-connector enrol --token ptk_...     one-time enrolment
proxility-connector status                    sessions, certificate expiry, transport
proxility-connector renew                     force certificate renewal
proxility-connector test <service>            resolve and connect, printing each step
```

`test` is the first thing to reach for when something does not work — it prints
resolution, policy verdict, handshake and target connection as separate steps,
so the failing one is obvious. See
[Troubleshooting](/docs/proxility/troubleshooting).

## Exit codes

| Code | Meaning |
|---|---|
| `0` | Success |
| `1` | Usage or validation error |
| `2` | Authentication or authorisation failure |
| `3` | Denied by policy |
| `4` | Control plane unreachable |

`--dry-run` on `policy apply` exits `0` when the file matches the live rule set
and non-zero when it would change anything, which makes it usable as a CI drift
check.
