mirror of
https://github.com/psviderski/uncloud.git
synced 2026-08-26 11:03:34 +00:00
docs: generate CLI reference docs for wg commands
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user