- NAME
-
- gcloud beta topic cli-trees - CLI trees supplementary help
- DESCRIPTION
-
(BETA)CLI trees are static nested dictionaries that describe all of the groups, commands, flags, positionals, help text, and completer module paths for a CLI. A CLI tree is often much faster to load and access than one generated at runtime from an active CLI. It is also a more compact representation. A properly formed CLI tree can be used to reproduce the help documentation for an entire CLI. - CLI Tree Data Files
-
A CLI tree is a dictionary in a JSON file. By convention, the file base name is
the corresponding CLI name. For example, the CLI tree file name for
gcloudisgcloud.json.CLI trees associated with Google Cloud CLI modules are installed in the
data/clisubdirectory of the Google Cloud CLI installation root:$(gcloud info --format="value(installation.sdk_root)")/data/cli
This includes tree data for
gcloud(core component),bq,gsutil, andkubectl. Note that the tree data is installed with the component. If the component is not installed then neither is its CLI tree. An installed component does not require its CLI tree to run. Only thegcloudCLI tree is required by$ gcloud alpha interactive.By default, CLI trees for other commands are JSON files generated on demand from their
man(1) orman7.orgman pages. They are cached in theclisubdirectory of the global config directory:$(gcloud info --format="value(config.paths.global_config_dir)")/cli
- The gcloud CLI Tree
-
The
gcloudCLI tree is used for static TAB completion, the corpus for$ gcloud alpha help-search, and the data source for$ gcloud alpha interactivecompletions and help text generation. - Other CLI Trees
-
$ gcloud alpha interactiveuses CLI tree data files for typeahead, command line completion and active help. A few CLI trees are installed with their respective Google Cloud CLI components:gcloud(core component),bq,gsutil, andkubectl.The generated trees are a close approximation. You can construct your own, especially for hierarchical CLIs like
git(1) that are hard to extract from man pages. - CLI Tree Schema
-
TBD (
gcloud interactiveis still in ALPHA). - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud topic cli-treesgcloud alpha topic cli-trees
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]