From 519825c34ab7b24684c83b50d5e1f2b0ec8c42d0 Mon Sep 17 00:00:00 2001 From: Pasha Sviderski Date: Tue, 5 May 2026 13:51:28 +1000 Subject: [PATCH] docs: regenerate CLI reference --- website/docs/9-cli-reference/uc_machine_add.md | 7 ++++--- website/docs/9-cli-reference/uc_machine_init.md | 7 ++++--- website/docs/9-cli-reference/uc_machine_update.md | 5 +++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/website/docs/9-cli-reference/uc_machine_add.md b/website/docs/9-cli-reference/uc_machine_add.md index 88143395..3b92f467 100644 --- a/website/docs/9-cli-reference/uc_machine_add.md +++ b/website/docs/9-cli-reference/uc_machine_add.md @@ -24,10 +24,11 @@ uc machine add [USER@]HOST[:PORT] [flags] --public-ip string Public IP address of the machine for ingress configuration. Use 'auto' for automatic detection, blank '' or 'none' to disable ingress on this machine, or specify an IP address. (default "auto") -i, --ssh-key string Path to SSH private key for remote login (if not already added to SSH agent). (default "~/.ssh/id_ed25519") --version string Version of the Uncloud daemon to install on the machine. (default "latest") - --wg-endpoint strings WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted. - Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine. + --wg-endpoint strings WireGuard endpoint address that other machines in the cluster should use to establish WireGuard connections + to this machine. This doesn't change the address/port WireGuard listens on the machine. + Format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port is 51820 if omitted. Multiple endpoints can be specified by repeating the flag or using a comma-separated list. - If not specified, the machine's routable IPs and public IP are auto-detected and used as endpoints. + Defaults to the auto-detected public and routable machine IPs. -y, --yes Auto-confirm prompts (e.g., resetting an already initialised machine). Should be explicitly set when running non-interactively, e.g., in CI/CD pipelines. [$UNCLOUD_AUTO_CONFIRM] ``` diff --git a/website/docs/9-cli-reference/uc_machine_init.md b/website/docs/9-cli-reference/uc_machine_init.md index 4bc715f1..30977328 100644 --- a/website/docs/9-cli-reference/uc_machine_init.md +++ b/website/docs/9-cli-reference/uc_machine_init.md @@ -46,10 +46,11 @@ uc machine init [schema://]USER@HOST[:PORT] [flags] --public-ip string Public IP address of the machine for ingress configuration. Use 'auto' for automatic detection, blank '' or 'none' to disable ingress on this machine, or specify an IP address. (default "auto") -i, --ssh-key string Path to SSH private key for remote login (if not already added to SSH agent). (default "~/.ssh/id_ed25519") --version string Version of the Uncloud daemon to install on the machine. (default "latest") - --wg-endpoint strings WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted. - Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine. + --wg-endpoint strings WireGuard endpoint address that other machines in the cluster should use to establish WireGuard connections + to this machine. This doesn't change the address/port WireGuard listens on the machine. + Format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port is 51820 if omitted. Multiple endpoints can be specified by repeating the flag or using a comma-separated list. - If not specified, the machine's routable IPs and public IP are auto-detected and used as endpoints. + Defaults to the auto-detected public and routable machine IPs. -y, --yes Auto-confirm prompts (e.g., resetting an already initialised machine). Should be explicitly set when running non-interactively, e.g., in CI/CD pipelines. [$UNCLOUD_AUTO_CONFIRM] ``` diff --git a/website/docs/9-cli-reference/uc_machine_update.md b/website/docs/9-cli-reference/uc_machine_update.md index 5a8aa26d..670b2850 100644 --- a/website/docs/9-cli-reference/uc_machine_update.md +++ b/website/docs/9-cli-reference/uc_machine_update.md @@ -38,8 +38,9 @@ uc machine update MACHINE [flags] -h, --help help for update --name string New name for the machine --public-ip string Public IP address of the machine for ingress configuration. Use 'none' or '' to remove the public IP. - --wg-endpoint strings WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted. - Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine. + --wg-endpoint strings WireGuard endpoint address that other machines in the cluster should use to establish WireGuard connections + to this machine. This doesn't change the address/port WireGuard listens on the machine. + Format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port is 51820 if omitted. Multiple endpoints can be specified by repeating the flag or using a comma-separated list. ```