docs: add Docker/OrbStack CLI connection note to CLI README

This commit is contained in:
Joseph Doherty
2026-03-18 07:04:53 -04:00
parent 899dec6b6f
commit 6ee820b0f0

View File

@@ -28,6 +28,12 @@ For a two-node HA cluster, supply both nodes comma-separated:
scadalink --contact-points akka.tcp://scadalink@node1:8081,akka.tcp://scadalink@node2:8082 <command>
```
**Docker (OrbStack):** When running against Docker containers, the contact point hostname must match the central container's Akka `NodeHostname` config. With OrbStack, add `/etc/hosts` entries mapping the container names to their IPs (see `docker/README.md`). Example:
```sh
scadalink --contact-points akka.tcp://scadalink@scadalink-central-a:8081 <command>
```
## Global Options
These options are accepted by the root command and inherited by all subcommands.
@@ -1025,6 +1031,24 @@ scadalink --contact-points <uri> health parked-messages --site-identifier <strin
---
### `debug` — Runtime debugging
#### `debug snapshot`
Request a point-in-time snapshot of a running instance's current attribute values and alarm states from the site. The instance must be deployed and enabled.
```sh
scadalink --contact-points <uri> debug snapshot --id <int>
```
| Option | Required | Description |
|--------|----------|-------------|
| `--id` | yes | Instance ID |
The command resolves the instance's site internally and routes the request to the correct site cluster. Returns all attribute values (name, value, quality, timestamp) and alarm states (name, state, priority, timestamp) at the moment the request reaches the site.
---
### `audit-log` — Audit log queries
#### `audit-log query`