Skip to content

Commit

Permalink
docs: expand help for 'talosctl get'
Browse files Browse the repository at this point in the history
Make it more obvious how to get list of all resources.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
  • Loading branch information
smira committed Dec 5, 2022
1 parent fcffc88 commit f0dddca
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion cmd/talosctl/cmd/talos/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ var getCmd = &cobra.Command{
Use: "get <type> [<id>]",
Aliases: []string{"g"},
SuggestFor: []string{},
Short: "Get a specific resource or list of resources.",
Short: "Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).",
Long: `Similar to 'kubectl get', 'talosctl get' returns a set of resources from the OS.
To get a list of all available resource definitions, issue 'talosctl get rd'`,
Example: "",
Expand Down
4 changes: 2 additions & 2 deletions website/content/v1.3/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1350,7 +1350,7 @@ Generate CAs, certificates, and private keys

## talosctl get

Get a specific resource or list of resources.
Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).

### Synopsis

Expand Down Expand Up @@ -2482,7 +2482,7 @@ A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl etcd](#talosctl-etcd) - Manage etcd
* [talosctl events](#talosctl-events) - Stream runtime events
* [talosctl gen](#talosctl-gen) - Generate CAs, certificates, and private keys
* [talosctl get](#talosctl-get) - Get a specific resource or list of resources.
* [talosctl get](#talosctl-get) - Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).
* [talosctl health](#talosctl-health) - Check cluster health
* [talosctl images](#talosctl-images) - List the default images used by Talos
* [talosctl inject](#talosctl-inject) - Inject Talos API resources into Kubernetes manifests
Expand Down

0 comments on commit f0dddca

Please sign in to comment.