chore: Regenerate CLI docs

This commit is contained in:
Anton Ovchinnikov
2025-12-26 12:23:59 +01:00
parent 4be1ea3506
commit 33a3683196
9 changed files with 26 additions and 12 deletions
+4 -2
View File
@@ -19,17 +19,19 @@ A CLI tool for managing Uncloud resources such as machines, services, and volume
* [uc ctx](uc_ctx.md) - Switch between different cluster contexts. Contains subcommands to manage contexts. * [uc ctx](uc_ctx.md) - Switch between different cluster contexts. Contains subcommands to manage contexts.
* [uc deploy](uc_deploy.md) - Deploy services from a Compose file. * [uc deploy](uc_deploy.md) - Deploy services from a Compose file.
* [uc dns](uc_dns.md) - Manage cluster domain in Uncloud DNS. * [uc dns](uc_dns.md) - Manage cluster domain in Uncloud DNS.
* [uc exec](uc_exec.md) - Execute a command in a running service container * [uc exec](uc_exec.md) - Execute a command in a running service container.
* [uc image](uc_image.md) - Manage images on machines in the cluster. * [uc image](uc_image.md) - Manage images on machines in the cluster.
* [uc images](uc_images.md) - List images on machines in the cluster. * [uc images](uc_images.md) - List images on machines in the cluster.
* [uc inspect](uc_inspect.md) - Display detailed information on a service. * [uc inspect](uc_inspect.md) - Display detailed information on a service.
* [uc logs](uc_logs.md) - View service logs. * [uc logs](uc_logs.md) - View service logs.
* [uc ls](uc_ls.md) - List services. * [uc ls](uc_ls.md) - List services.
* [uc machine](uc_machine.md) - Manage machines in the cluster. * [uc machine](uc_machine.md) - Manage machines in the cluster.
* [uc ps](uc_ps.md) - List all service containers in the cluster * [uc ps](uc_ps.md) - List all service containers.
* [uc rm](uc_rm.md) - Remove one or more services. * [uc rm](uc_rm.md) - Remove one or more services.
* [uc run](uc_run.md) - Run a service. * [uc run](uc_run.md) - Run a service.
* [uc scale](uc_scale.md) - Scale a replicated service by changing the number of replicas. * [uc scale](uc_scale.md) - Scale a replicated service by changing the number of replicas.
* [uc service](uc_service.md) - Manage services in the cluster. * [uc service](uc_service.md) - Manage services in the cluster.
* [uc start](uc_start.md) - Start one or more services.
* [uc stop](uc_stop.md) - Stop one or more services.
* [uc volume](uc_volume.md) - Manage volumes in the cluster. * [uc volume](uc_volume.md) - Manage volumes in the cluster.
+1 -1
View File
@@ -1,6 +1,6 @@
# uc exec # uc exec
Execute a command in a running service container Execute a command in a running service container.
## Synopsis ## Synopsis
@@ -24,6 +24,8 @@ 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") --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).
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
@@ -12,7 +12,7 @@ Connection methods:
ssh+cli://user@host - Use system SSH command (supports ProxyJump, SSH config) ssh+cli://user@host - Use system SSH command (supports ProxyJump, SSH config)
``` ```
uc machine init [USER@HOST:PORT] [flags] uc machine init [schema://]USER@HOST[:PORT] [flags]
``` ```
## Examples ## Examples
@@ -46,6 +46,8 @@ uc machine init [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")
-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
+2 -2
View File
@@ -1,6 +1,6 @@
# uc ps # uc ps
List all service containers in the cluster List all service containers.
## Synopsis ## Synopsis
@@ -17,7 +17,7 @@ uc ps [flags]
``` ```
-h, --help help for ps -h, --help help for ps
-s, --sort string Sort containers by 'service', 'machine' or 'health' (default "service") -s, --sort string Sort containers by 'service', 'machine', or 'health'. (default "service")
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
+1 -1
View File
@@ -20,7 +20,7 @@ Manage services in the cluster.
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc service exec](uc_service_exec.md) - Execute a command in a running service container * [uc service exec](uc_service_exec.md) - Execute a command in a running service container.
* [uc service inspect](uc_service_inspect.md) - Display detailed information on a service. * [uc service inspect](uc_service_inspect.md) - Display detailed information on a service.
* [uc service logs](uc_service_logs.md) - View service logs. * [uc service logs](uc_service_logs.md) - View service logs.
* [uc service ls](uc_service_ls.md) - List services. * [uc service ls](uc_service_ls.md) - List services.
@@ -1,6 +1,6 @@
# uc service exec # uc service exec
Execute a command in a running service container Execute a command in a running service container.
## Synopsis ## Synopsis
@@ -4,7 +4,10 @@ Start one or more services.
## Synopsis ## Synopsis
Start one or more services. Start one or more previously stopped services.
Starts all containers of the specified service(s) across all machines in the cluster.
Services can be specified by name or ID.
``` ```
uc service start SERVICE [SERVICE...] [flags] uc service start SERVICE [SERVICE...] [flags]
@@ -4,7 +4,10 @@ Stop one or more services.
## Synopsis ## Synopsis
Stop one or more services. Stop one or more running services.
Gracefully stops all containers of the specified service(s) across all machines in the cluster.
Services can be specified by name or ID. Stopped services can be restarted with 'uc start'.
``` ```
uc service stop SERVICE [SERVICE...] [flags] uc service stop SERVICE [SERVICE...] [flags]
@@ -14,8 +17,10 @@ uc service stop SERVICE [SERVICE...] [flags]
``` ```
-h, --help help for stop -h, --help help for stop
-s, --signal string Signal to send to the container -s, --signal string Signal to send to each container's main process.
-t, --timeout int Seconds to wait before killing the container Can be a signal name (SIGTERM, SIGINT, SIGHUP, etc.) or a number. (default SIGTERM)
-t, --timeout int Seconds to wait for each container to stop gracefully before forcibly killing it with SIGKILL.
Use -1 to wait indefinitely. (default 10)
``` ```
## Options inherited from parent commands ## Options inherited from parent commands