Stay organized with collections
Save and categorize content based on your preferences.
NAME
gdcloud topic offline-help - Supplementary help for gdcloud CLI offline help.
DESCRIPTION
There are multiple ways to access gdcloud CLI command help.
* Add the --help flag to any command. This renders a help document in a terminal pager. The document is always up-to-date with the command because it is generated by collating help text from the command itself.
* Use the gdcloud topic command to view a particular feature's supplementary help text.
* Use the static HTML documents provided in the downloaded CLI bundle.
All the methods are available after the gdcloud CLI installation.
Offline HTML Documents
The offline HTML documents are in a tar file inside the data/offline-help/docs/ folder. To access these documents, the tar file must be extracted; the directory it is extracted to depends on the user. If the CLI tar file can't be found, then it can be downloaded from the GDC website.
The top-level file for these static HTML documents is the gdch.html file. If the tar file is extracted in the HOME directory, then the gdch.html file will be located at $HOME/static/docs/distributed-cloud/hosted/docs/latest/.
[[["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-05 UTC."],[[["The gdcloud CLI offers multiple ways to access command help, including the `--help` flag, `gdcloud topic` command, and offline HTML documents."],["Adding the `--help` flag to any gdcloud command generates an up-to-date help document directly from the command's help text."],["Supplementary feature-specific help is available through the `gdcloud topic` command."],["Offline HTML documentation is bundled with the CLI in a tar file located within the `data/offline-help/docs/` folder."],["Access to the offline documentation requires extracting the tar file, with the main `gdch.html` file found in the extracted `static/docs/distributed-cloud/hosted/docs/latest/` directory."]]],[]]
