docs: regenerate CLI reference

This commit is contained in:
Pasha Sviderski
2026-03-04 12:47:21 +10:00
parent bad0f97b66
commit c039390ade
3 changed files with 25 additions and 35 deletions
@@ -25,6 +25,5 @@ Manage machines in the cluster.
* [uc machine ls](uc_machine_ls.md) - List machines in a cluster. * [uc machine ls](uc_machine_ls.md) - List machines in a cluster.
* [uc machine rename](uc_machine_rename.md) - Rename a machine in the cluster. * [uc machine rename](uc_machine_rename.md) - Rename a machine in the cluster.
* [uc machine rm](uc_machine_rm.md) - Remove a machine from a cluster and reset it. * [uc machine rm](uc_machine_rm.md) - Remove a machine from a cluster and reset it.
* [uc machine token](uc_machine_token.md) - Print the local machine's token for adding it to a cluster.
* [uc machine update](uc_machine_update.md) - Update machine configuration in the cluster. * [uc machine update](uc_machine_update.md) - Update machine configuration in the cluster.
@@ -1,28 +0,0 @@
# uc machine token
Print the local machine's token for adding it to a cluster.
```
uc machine token [flags]
```
## Options
```
-d, --data-dir string Directory for storing persistent machine state. (default "/var/lib/uncloud")
-h, --help help for token
```
## Options inherited from parent commands
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock
-c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT]
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
## See also
* [uc machine](uc_machine.md) - Manage machines in the cluster.
@@ -6,19 +6,38 @@ Update machine configuration in the cluster.
Update machine configuration in the cluster. Update machine configuration in the cluster.
This command allows setting various machine properties including: Change the name, public IP address, or WireGuard endpoints of an existing machine.
- Machine name (--name) At least one flag must be specified to perform an update.
- Public IP address (--public-ip)
At least one flag must be specified to perform an update operation.
``` ```
uc machine update [flags] uc machine update MACHINE [flags]
```
## Examples
```
# Rename a machine.
uc machine update machine1 --name web-server
# Set the public IP address of a machine.
uc machine update machine1 --public-ip 203.0.113.10
# Remove the public IP address from a machine.
uc machine update machine1 --public-ip none
# Update WireGuard endpoints for a machine.
uc machine update machine1 --endpoint 203.0.113.10 --endpoint 192.168.1.5
# Update multiple properties at once.
uc machine update machine1 --name web-server --public-ip 203.0.113.10
``` ```
## Options ## Options
``` ```
--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 these endpoints to establish a WireGuard connection to this machine.
Multiple endpoints can be specified by repeating the flag or using a comma-separated list.
-h, --help help for update -h, --help help for update
--name string New name for the machine --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. --public-ip string Public IP address of the machine for ingress configuration. Use 'none' or '' to remove the public IP.