Stay organized with collections
Save and categorize content based on your preferences.
NAME
gdcloud topic cli-trees - Supplementary help for CLI trees.
DESCRIPTION
CLI trees are static nested dictionaries that describe all groups, commands, flags, positionals, help text, and completer module paths for a CLI. A static CLI tree is often much faster to load and access than a CLI tree 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-Trees Data Files
A CLI tree is a dictionary stored in a JSON file. By convention, the file base name is the corresponding CLI name. For example, the CLI tree file name for the gdcloud CLI is gdcloud.json.
CLI trees associated with gdcloud CLI modules are installed in the data/cli subdirectory of the root of the unzipped gdcloud CLI bundle directory.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-21 UTC."],[[["CLI trees are static, nested dictionaries that define a CLI's structure, including commands, flags, and help text."],["They are faster to load and access compared to runtime-generated CLI trees and represent the information in a more compact format."],["CLI trees are stored as JSON files, with the filename typically matching the corresponding CLI name (e.g., `gdcloud.json` for the gdcloud CLI)."],["The gdcloud CLI tree is located in the `data/cli` subdirectory within the unzipped gdcloud CLI bundle, yet the gdcloud CLI does not require this file to run."]]],[]]
