philipp/uncloud
1
0
Fork 0
mirror of https://github.com/psviderski/uncloud.git synced 2026-08-26 11:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: regenerate CLI reference

Browse Source
This commit is contained in:
Pasha Sviderski
2026-05-05 13:51:28 +10:00
parent eebb7b51ed
commit 519825c34a
3 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/9-cli-reference/uc_machine_add.md
+4 -3
View File
@@ -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]
```
website/docs/9-cli-reference/uc_machine_init.md
+4 -3
View File
@@ -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]
```
website/docs/9-cli-reference/uc_machine_update.md
+3 -2
View File
@@ -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.
```