From 1caa5ccf0e77ad0b11ec80be8cd0a9bf74f4d09f Mon Sep 17 00:00:00 2001 From: Pasha Sviderski Date: Sat, 10 Jan 2026 18:37:40 +1100 Subject: [PATCH] docs: generate CLI reference docs for wg commands --- website/docs/9-cli-reference/uc.md | 1 + website/docs/9-cli-reference/uc_wg.md | 24 ++++++++++++++++ website/docs/9-cli-reference/uc_wg_show.md | 32 ++++++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 website/docs/9-cli-reference/uc_wg.md create mode 100644 website/docs/9-cli-reference/uc_wg_show.md diff --git a/website/docs/9-cli-reference/uc.md b/website/docs/9-cli-reference/uc.md index 07d06020..bc687f80 100644 --- a/website/docs/9-cli-reference/uc.md +++ b/website/docs/9-cli-reference/uc.md @@ -34,4 +34,5 @@ A CLI tool for managing Uncloud resources such as machines, services, and volume * [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 wg](uc_wg.md) - Inspect WireGuard network diff --git a/website/docs/9-cli-reference/uc_wg.md b/website/docs/9-cli-reference/uc_wg.md new file mode 100644 index 00000000..a514bcbb --- /dev/null +++ b/website/docs/9-cli-reference/uc_wg.md @@ -0,0 +1,24 @@ +# uc wg + +Inspect WireGuard network + +## Options + +``` + -h, --help help for wg +``` + +## 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](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes. +* [uc wg show](uc_wg_show.md) - Show WireGuard network configuration for a machine. + diff --git a/website/docs/9-cli-reference/uc_wg_show.md b/website/docs/9-cli-reference/uc_wg_show.md new file mode 100644 index 00000000..8d1c33ca --- /dev/null +++ b/website/docs/9-cli-reference/uc_wg_show.md @@ -0,0 +1,32 @@ +# uc wg show + +Show WireGuard network configuration for a machine. + +## Synopsis + +Show the WireGuard network configuration for the machine currently connected to (or specified by the global --connect flag). + +``` +uc wg show [flags] +``` + +## Options + +``` + -h, --help help for show + -m, --machine string Name or ID of the machine to show the configuration for. (default is connected machine) +``` + +## 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 wg](uc_wg.md) - Inspect WireGuard network +