From 39690eed72717190d1cb74c250b3deb0a2b28f3e Mon Sep 17 00:00:00 2001 From: Pasha Sviderski Date: Wed, 22 Apr 2026 14:00:50 +1000 Subject: [PATCH] docs: regenerate CLI reference --- website/docs/9-cli-reference/uc_ctx_show.md | 27 +++++++++++++++++++ website/docs/9-cli-reference/uc_logs.md | 8 +++++- .../docs/9-cli-reference/uc_service_logs.md | 8 +++++- 3 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 website/docs/9-cli-reference/uc_ctx_show.md diff --git a/website/docs/9-cli-reference/uc_ctx_show.md b/website/docs/9-cli-reference/uc_ctx_show.md new file mode 100644 index 00000000..703625a7 --- /dev/null +++ b/website/docs/9-cli-reference/uc_ctx_show.md @@ -0,0 +1,27 @@ +# uc ctx show + +Show current cluster context. + +``` +uc ctx show [flags] +``` + +## Options + +``` + -h, --help help for show +``` + +## 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+go://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 ctx](uc_ctx.md) - Switch between different cluster contexts. Contains subcommands to manage contexts. + diff --git a/website/docs/9-cli-reference/uc_logs.md b/website/docs/9-cli-reference/uc_logs.md index 8f1160b7..ce79284d 100644 --- a/website/docs/9-cli-reference/uc_logs.md +++ b/website/docs/9-cli-reference/uc_logs.md @@ -6,11 +6,14 @@ View service logs. View logs from all replicas of the specified service(s) across all machines in the cluster. +To view logs from specific replicas (containers) within a service, use the SERVICE/CONTAINER form, +where CONTAINER is a container name, full ID, or unique ID prefix. + If no services are specified, streams logs from all services defined in the Compose file (compose.yaml by default or the file(s) specified with --file). ``` -uc logs [SERVICE...] [flags] +uc logs [SERVICE[/CONTAINER]...] [flags] ``` ## Examples @@ -37,6 +40,9 @@ uc logs [SERVICE...] [flags] # View logs from a specific time range. uc logs --since 3h --until 1h30m web + # View logs only from specific replicas (containers). + uc logs web/61d57fd3428f api/2f60 + # View logs only from replicas running on specific machines. uc logs -m machine1,machine2 web api ``` diff --git a/website/docs/9-cli-reference/uc_service_logs.md b/website/docs/9-cli-reference/uc_service_logs.md index da2701e6..1b817f5f 100644 --- a/website/docs/9-cli-reference/uc_service_logs.md +++ b/website/docs/9-cli-reference/uc_service_logs.md @@ -6,11 +6,14 @@ View service logs. View logs from all replicas of the specified service(s) across all machines in the cluster. +To view logs from specific replicas (containers) within a service, use the SERVICE/CONTAINER form, +where CONTAINER is a container name, full ID, or unique ID prefix. + If no services are specified, streams logs from all services defined in the Compose file (compose.yaml by default or the file(s) specified with --file). ``` -uc service logs [SERVICE...] [flags] +uc service logs [SERVICE[/CONTAINER]...] [flags] ``` ## Examples @@ -37,6 +40,9 @@ uc service logs [SERVICE...] [flags] # View logs from a specific time range. uc logs --since 3h --until 1h30m web + # View logs only from specific replicas (containers). + uc logs web/61d57fd3428f api/2f60 + # View logs only from replicas running on specific machines. uc logs -m machine1,machine2 web api ```