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-08-25 UTC."],[[["\u003cp\u003eThe gdcloud CLI offers multiple ways to access command help, including the \u003ccode\u003e--help\u003c/code\u003e flag, \u003ccode\u003egdcloud topic\u003c/code\u003e command, and offline HTML documents.\u003c/p\u003e\n"],["\u003cp\u003eAdding the \u003ccode\u003e--help\u003c/code\u003e flag to any gdcloud command generates an up-to-date help document directly from the command's help text.\u003c/p\u003e\n"],["\u003cp\u003eSupplementary feature-specific help is available through the \u003ccode\u003egdcloud topic\u003c/code\u003e command.\u003c/p\u003e\n"],["\u003cp\u003eOffline HTML documentation is bundled with the CLI in a tar file located within the \u003ccode\u003edata/offline-help/docs/\u003c/code\u003e folder.\u003c/p\u003e\n"],["\u003cp\u003eAccess to the offline documentation requires extracting the tar file, with the main \u003ccode\u003egdch.html\u003c/code\u003e file found in the extracted \u003ccode\u003estatic/docs/distributed-cloud/hosted/docs/latest/\u003c/code\u003e directory.\u003c/p\u003e\n"]]],[],null,["# gdcloud topic offline-help\n\nNAME\n----\n\ngdcloud topic offline-help - Supplementary help for gdcloud CLI offline help.\n\nDESCRIPTION\n-----------\n\nThere are multiple ways to access gdcloud CLI command help.\n\\* 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.\n\\* Use the `gdcloud topic` command to view a particular feature's supplementary help text.\n\\* Use the static HTML documents provided in the downloaded CLI bundle.\nAll the methods are available after the gdcloud CLI installation.\n\nOffline HTML Documents\n----------------------\n\nThe 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.\nThe 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/`."]]
