docs: 'uc docs' command to generate CLI reference docs

This commit is contained in:
Pasha Sviderski
2025-08-28 20:09:18 +10:00
parent 290e6db98e
commit 7c19323ea1
41 changed files with 1265 additions and 1 deletions
@@ -0,0 +1,28 @@
# uc volume inspect
Display detailed information on a volume.
```
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.
```
## Options inherited from parent commands
```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file.
Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml")
```
## See also
* [uc volume](uc_volume.md) - Manage volumes in an Uncloud cluster.