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: regenereate CLI reference

Browse Source
This commit is contained in:
Pasha Sviderski
2025-11-20 10:53:37 +10:00
parent 75085b3929
commit ce4a8cce72
44 changed files with 97 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/9-cli-reference/uc.md
+1
View File
@@ -7,6 +7,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], ssh+cli://user@host[:port], or tcp://host:port
-c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT]
-h, --help help for uc
--uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
```
website/docs/9-cli-reference/uc_build.md
+1 -1
View File
@@ -41,7 +41,6 @@ uc build [FLAGS] [SERVICE...] [flags]
--build-arg stringArray Set a build-time variable for services. Used in Dockerfiles that declare the variable with ARG.
Can be specified multiple times. Format: --build-arg VAR=VALUE
--check Check the build configuration for services without building them.
-c, --context string Name of the cluster context. (default is the current context)
--deps Also build services declared as dependencies of the selected services.
-f, --file strings One or more Compose files to build. (default compose.yaml)
-h, --help help for build
@@ -60,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_caddy.md
+1
View File
@@ -13,6 +13,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_caddy_config.md
+1 -1
View File
@@ -13,7 +13,6 @@ uc caddy config [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for config
-m, --machine string Name or ID of the machine to get the configuration from. (default is connected machine)
--no-color Disable syntax highlighting for the output.
@@ -24,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_caddy_deploy.md
+1 -1
View File
@@ -15,7 +15,6 @@ uc caddy deploy [flags]
```
--caddyfile string Path to a custom global Caddy config (Caddyfile) that will be prepended to the auto-generated Caddy config.
-c, --context string Name of the cluster context to deploy to. (default is the current context)
-h, --help help for deploy
--image string Caddy Docker image to deploy. (default caddy:LATEST_VERSION)
-m, --machine strings Machine names or IDs to deploy to. Can be specified multiple times or as a comma-separated list. (default is all machines)
@@ -26,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_ctx.md
+2
View File
@@ -17,12 +17,14 @@ uc ctx [flags]
```
--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], or tcp://host:port
-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](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc ctx connection](uc_ctx_connection.md) - Choose a new default connection for the current context.
* [uc ctx ls](uc_ctx_ls.md) - List available cluster contexts.
* [uc ctx use](uc_ctx_use.md) - Switch to a different cluster context.
website/docs/9-cli-reference/uc_ctx_connection.md
+27
View File
@@ -0,0 +1,27 @@
# uc ctx connection
Choose a new default connection for the current context.
```
uc ctx connection [flags]
```
## Options
```
-h, --help help for connection
```
## 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], or tcp://host:port
-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 ctx](uc_ctx.md) - Switch between different cluster contexts. Contains subcommands to manage contexts.
website/docs/9-cli-reference/uc_ctx_ls.md
+1
View File
@@ -17,6 +17,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_ctx_use.md
+1
View File
@@ -21,6 +21,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_deploy.md
+1 -1
View File
@@ -12,7 +12,6 @@ uc deploy [FLAGS] [SERVICE...] [flags]
--build-arg stringArray Set a build-time variable for services. Used in Dockerfiles that declare the variable with ARG.
Can be specified multiple times. Format: --build-arg VAR=VALUE
--build-pull Always attempt to pull newer versions of base images before building service images.
-c, --context string Name of the cluster context to deploy to (default is the current context)
-f, --file strings One or more Compose files to deploy services from. (default compose.yaml)
-h, --help help for deploy
--no-build Do not build new images before deploying services.
@@ -28,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_dns.md
+1
View File
@@ -18,6 +18,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_dns_release.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc dns release [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for release
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_dns_reserve.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc dns reserve [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
--endpoint string API endpoint for the Uncloud DNS service. (default "https://dns.uncloud.run/v1")
-h, --help help for reserve
```
@@ -19,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_dns_show.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc dns show [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for show
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_exec.md
+1 -1
View File
@@ -36,7 +36,6 @@ uc exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags]
```
--container string ID of the container to exec into. Accepts full ID or a unique prefix (default is the random container of the service)
-c, --context string Name of the cluster context. (default is the current context)
-d, --detach Detached mode: run command in the background
-h, --help help for exec
-T, --no-tty Disable pseudo-TTY allocation. By default 'uc exec' allocates a TTY when connected to a terminal.
@@ -47,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_image.md
+1
View File
@@ -13,6 +13,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_image_ls.md
+1 -1
View File
@@ -32,7 +32,6 @@ uc image ls [REPO:[TAG]] [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for ls
-m, --machine strings Filter images by machine name or ID. Can be specified multiple times or as a comma-separated list. (default is include all machines)
```
@@ -42,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_image_push.md
+1 -1
View File
@@ -30,7 +30,6 @@ uc image push IMAGE [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for push
-m, --machine strings Machine names or IDs to push the image to. Can be specified multiple times or as a comma-separated list. (default is all machines)
--platform string Push a specific platform of a multi-platform image (e.g., linux/amd64, linux/arm64).
@@ -42,6 +41,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_images.md
+1 -1
View File
@@ -32,7 +32,6 @@ uc images [IMAGE] [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for images
-m, --machine strings Filter images by machine name or ID. Can be specified multiple times or as a comma-separated list. (default is include all machines)
```
@@ -42,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_inspect.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc inspect SERVICE [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for inspect
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_ls.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc ls [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for ls
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine.md
+1
View File
@@ -13,6 +13,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine_add.md
+9 -1
View File
@@ -2,6 +2,14 @@
Add a remote machine to a cluster.
## Synopsis
Add a new machine to an existing Uncloud cluster.
Connection methods:
ssh://user@host - Use built-in SSH library (default, no prefix required)
ssh+cli://user@host - Use system SSH command (supports ProxyJump, SSH config)
```
uc machine add [USER@]HOST[:PORT] [flags]
```
@@ -9,7 +17,6 @@ uc machine add [USER@]HOST[:PORT] [flags]
## Options
```
-c, --context string Name of the cluster context to add the machine to. (default is the current context)
-h, --help help for add
-n, --name string Assign a name to the machine.
--no-caddy Don't deploy Caddy reverse proxy service to the machine.
@@ -24,6 +31,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine_init.md
+4
View File
@@ -7,6 +7,10 @@ Initialise a new cluster with a remote machine as the first member.
Initialise a new cluster by setting up a remote machine as the first member.
This command creates a new context in your Uncloud config to manage the cluster.
Connection methods:
ssh://user@host - Use built-in SSH library (default, no prefix required)
ssh+cli://user@host - Use system SSH command (supports ProxyJump, SSH config)
```
uc machine init [USER@HOST:PORT] [flags]
```
website/docs/9-cli-reference/uc_machine_ls.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc machine ls [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for ls
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine_rename.md
+1 -1
View File
@@ -16,7 +16,6 @@ uc machine rename OLD_NAME NEW_NAME [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for rename
```
@@ -25,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine_rm.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc machine rm MACHINE [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for rm
--no-reset Do not reset the machine after removing it from the cluster. This will leave all containers and data intact.
-y, --yes Do not prompt for confirmation before removing the machine.
@@ -20,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine_token.md
+1
View File
@@ -18,6 +18,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_machine_update.md
+1 -1
View File
@@ -19,7 +19,6 @@ uc machine update [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-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.
@@ -30,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_rm.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc rm SERVICE [SERVICE...] [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for rm
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_run.md
+1 -1
View File
@@ -10,7 +10,6 @@ uc run IMAGE [COMMAND...] [flags]
```
--caddyfile string Path to a custom Caddy config (Caddyfile) for the service. Cannot be used together with non-@host published ports.
-c, --context string Name of the cluster context to run the service in. (default is the current context)
--cpu decimal Maximum number of CPU cores a service container can use. Fractional values are allowed: 0.5 for half a core or 2.25 for two and a quarter cores.
--entrypoint string Overwrite the default ENTRYPOINT of the image. Pass an empty string "" to reset it.
-e, --env strings Set an environment variable for service containers. Can be specified multiple times.
@@ -48,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_scale.md
+1 -1
View File
@@ -13,7 +13,6 @@ uc scale SERVICE REPLICAS [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for scale
```
@@ -22,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service.md
+1
View File
@@ -13,6 +13,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service_exec.md
+1 -1
View File
@@ -36,7 +36,6 @@ uc service exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags]
```
--container string ID of the container to exec into. Accepts full ID or a unique prefix (default is the random container of the service)
-c, --context string Name of the cluster context. (default is the current context)
-d, --detach Detached mode: run command in the background
-h, --help help for exec
-T, --no-tty Disable pseudo-TTY allocation. By default 'uc exec' allocates a TTY when connected to a terminal.
@@ -47,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service_inspect.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc service inspect SERVICE [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for inspect
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service_ls.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc service ls [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for ls
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service_rm.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc service rm SERVICE [SERVICE...] [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for rm
```
@@ -18,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service_run.md
+1 -1
View File
@@ -10,7 +10,6 @@ uc service run IMAGE [COMMAND...] [flags]
```
--caddyfile string Path to a custom Caddy config (Caddyfile) for the service. Cannot be used together with non-@host published ports.
-c, --context string Name of the cluster context to run the service in. (default is the current context)
--cpu decimal Maximum number of CPU cores a service container can use. Fractional values are allowed: 0.5 for half a core or 2.25 for two and a quarter cores.
--entrypoint string Overwrite the default ENTRYPOINT of the image. Pass an empty string "" to reset it.
-e, --env strings Set an environment variable for service containers. Can be specified multiple times.
@@ -48,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_service_scale.md
+1 -1
View File
@@ -13,7 +13,6 @@ uc service scale SERVICE REPLICAS [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for scale
```
@@ -22,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_volume.md
+1
View File
@@ -13,6 +13,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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_volume_create.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc volume create VOLUME_NAME [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-d, --driver string Volume driver to use. (default "local")
-h, --help help for create
-l, --label strings Labels to assign to the volume in the form of 'key=value' pairs. Can be specified multiple times.
@@ -22,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_volume_inspect.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc volume inspect VOLUME_NAME [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for inspect
-m, --machine string Name or ID of the machine where the volume is located. If not specified, the volume will be searched across all machines.
```
@@ -19,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_volume_ls.md
+1 -1
View File
@@ -9,7 +9,6 @@ uc volume ls [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-h, --help help for ls
-m, --machine strings Filter volumes by machine name or ID. Can be specified multiple times or as a comma-separated list. (default is include all machines)
-q, --quiet Only display volume names.
@@ -20,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```
website/docs/9-cli-reference/uc_volume_rm.md
+1 -1
View File
@@ -13,7 +13,6 @@ uc volume rm VOLUME_NAME [VOLUME_NAME...] [flags]
## Options
```
-c, --context string Name of the cluster context. (default is the current context)
-f, --force Force the removal of one or more volumes.
-h, --help help for rm
-m, --machine strings Name or ID of the machine to remove one or more volumes from. Can be specified multiple times or as a comma-separated list.
@@ -26,6 +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], ssh+cli://user@host[:port], or tcp://host:port
-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")
```