docs: regenerate CLI reference docs

This commit is contained in:
Pasha Sviderski
2025-11-07 13:29:30 +10:00
parent 4de068c46e
commit 8c4f21ff81
44 changed files with 61 additions and 46 deletions
+1 -1
View File
@@ -6,7 +6,7 @@ A CLI tool for managing Uncloud resources such as machines, services, and volume
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
-h, --help help for uc
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -59,7 +59,7 @@ uc build [FLAGS] [SERVICE...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -12,7 +12,7 @@ Manage Caddy reverse proxy service.
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -23,7 +23,7 @@ uc caddy config [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -25,7 +25,7 @@ uc caddy deploy [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -16,7 +16,7 @@ uc ctx [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -16,7 +16,7 @@ uc ctx ls [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -20,7 +20,7 @@ uc ctx use [CONTEXT] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -27,7 +27,7 @@ uc deploy [FLAGS] [SERVICE...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -17,7 +17,7 @@ DNS commands allow you to reserve or release a unique '\<id>.cluster.uncloud.run
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -17,7 +17,7 @@ uc dns release [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -18,7 +18,7 @@ uc dns reserve [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -17,7 +17,7 @@ uc dns show [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -46,7 +46,7 @@ uc exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -12,7 +12,7 @@ Manage images on machines in the cluster.
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -41,7 +41,7 @@ uc image ls [REPO:[TAG]] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -44,7 +44,7 @@ uc image push IMAGE [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -41,7 +41,7 @@ uc images [IMAGE] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -17,7 +17,7 @@ uc inspect SERVICE [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -17,7 +17,7 @@ uc ls [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -12,7 +12,7 @@ Manage machines in an Uncloud cluster.
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -23,7 +23,7 @@ uc machine add [USER@]HOST[:PORT] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -48,7 +48,7 @@ uc machine init [USER@HOST:PORT] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -17,7 +17,7 @@ uc machine ls [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -24,7 +24,7 @@ uc machine rename OLD_NAME NEW_NAME [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -19,7 +19,7 @@ uc machine rm MACHINE [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -17,7 +17,7 @@ uc machine token [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -29,7 +29,7 @@ uc machine update [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -17,7 +17,7 @@ uc rm SERVICE [SERVICE...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -47,7 +47,7 @@ uc run IMAGE [COMMAND...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -21,7 +21,7 @@ uc scale SERVICE REPLICAS [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -12,7 +12,7 @@ Manage services in an Uncloud cluster.
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -46,7 +46,7 @@ uc service exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -17,7 +17,7 @@ uc service inspect SERVICE [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -17,7 +17,7 @@ uc service ls [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -17,7 +17,7 @@ uc service rm SERVICE [SERVICE...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -47,7 +47,7 @@ uc service run IMAGE [COMMAND...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -21,7 +21,7 @@ uc service scale SERVICE REPLICAS [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -12,7 +12,7 @@ Manage volumes in an Uncloud cluster.
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -21,7 +21,7 @@ uc volume create VOLUME_NAME [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
@@ -18,7 +18,7 @@ uc volume inspect VOLUME_NAME [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -19,7 +19,7 @@ uc volume ls [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
+1 -1
View File
@@ -25,7 +25,7 @@ uc volume rm VOLUME_NAME [VOLUME_NAME...] [flags]
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port
Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```