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-03-06 21:01:38 +10:00
parent 38c7dda6a0
commit 78a3551c77
3 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/9-cli-reference/uc_machine_add.md
+13 -9
View File
@@ -17,15 +17,19 @@ uc machine add [USER@]HOST[:PORT] [flags]
## Options ## Options
``` ```
-h, --help help for add -h, --help help for add
-n, --name string Assign a name to the machine. -n, --name string Assign a name to the machine.
--no-caddy Don't deploy Caddy reverse proxy service to the machine. --no-caddy Don't deploy Caddy reverse proxy service to the machine.
--no-install Skip installation of Docker, Uncloud daemon, and dependencies on the machine. Assumes they're already installed and running. --no-install Skip installation of Docker, Uncloud daemon, and dependencies on the machine. Assumes they're already installed and running.
--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") --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") -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") --version string Version of the Uncloud daemon to install on the machine. (default "latest")
-y, --yes Auto-confirm prompts (e.g., resetting an already initialised machine). --wg-endpoint strings WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted.
Should be explicitly set when running non-interactively, e.g., in CI/CD pipelines. [$UNCLOUD_AUTO_CONFIRM] Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine.
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.
-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]
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
website/docs/9-cli-reference/uc_machine_init.md
+4
View File
@@ -46,6 +46,10 @@ 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") --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") -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") --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.
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.
-y, --yes Auto-confirm prompts (e.g., resetting an already initialised machine). -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] 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
+7 -7
View File
@@ -26,7 +26,7 @@ uc machine update MACHINE [flags]
uc machine update machine1 --public-ip none uc machine update machine1 --public-ip none
# Update WireGuard endpoints for a machine. # Update WireGuard endpoints for a machine.
uc machine update machine1 --endpoint 203.0.113.10 --endpoint 192.168.1.5 uc machine update machine1 --wg-endpoint 203.0.113.10 --wg-endpoint 192.168.1.5
# Update multiple properties at once. # Update multiple properties at once.
uc machine update machine1 --name web-server --public-ip 203.0.113.10 uc machine update machine1 --name web-server --public-ip 203.0.113.10
@@ -35,12 +35,12 @@ uc machine update MACHINE [flags]
## Options ## Options
``` ```
--endpoint strings WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted. -h, --help help for update
Other machines in the cluster will use these endpoints to establish a WireGuard connection to this machine. --name string New name for the machine
Multiple endpoints can be specified by repeating the flag or using a comma-separated list. --public-ip string Public IP address of the machine for ingress configuration. Use 'none' or '' to remove the public IP.
-h, --help help for update --wg-endpoint strings WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted.
--name string New name for the machine Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine.
--public-ip string Public IP address of the machine for ingress configuration. Use 'none' or '' to remove the public IP. Multiple endpoints can be specified by repeating the flag or using a comma-separated list.
``` ```
## Options inherited from parent commands ## Options inherited from parent commands