gcloud beta topic offline-help

NAME
gcloud beta topic offline-help - setting up gcloud command offline help
DESCRIPTION
(BETA) There are many ways to accessgcloud command help. Only the firstrequires online access:
  • Add the--help flag to any command. This will render a man styledocument in a terminal pager. The document is always up to date with the commandbecause it is generated by collating help text from the command itself.
  • Use thegcloud betainteractive shell which has as-you-type help. Like--help, the interactive help documents are always up to date withthegcloud installation.
  • Generate HTML documents in a local directory and point your browser to thegeneratedindex.html for offline browsing. Hover over a navigationitem to focus the menu, hover to the left to expand it again. More details onthis below.
  • Generate and installman(1) style documents on a local host. Moredetails on this below.

All of these methods have the same content, all generated from a Google CloudCLIgcloud installation. Thelast two are user maintained and can become out of date. Either use them for onetime offline access, or make them part of your Google Cloud CLIinstallation/update routine.

Generating offline HTML documents
To generate HTML documents for offline browsing:
# Select an empty directory where the HTML and supporting *.css* and# *.js* files will be generated.HTML_DIR=<some-local-directory>
# Generate the HTML in $HTML_DIR.# Should take ~1 min, 10 min or more on slower systems.gcloudmetagenerate-help-docs--html-dir=$HTML_DIR

Then enter this URL in the browser address/search bar, where $HTML_DIR must bethe actual path name of the directory:

file://$HTML_DIR/index.html
Generating offline manpage documents
To generate man page documents for theman(1) command:
# Select an empty directory where the man page files will be generated.MANPAGE_DIR=<some-local-directory>
# Generate the man pages in $MANPAGE_DIR.# Should take ~1 min, 10 min or more on slower systems.gcloudmetagenerate-help-docs--manpage-dir=$MANPAGE_DIR
# Append $MANPAGE_DIR to the MANPATH environment variable:exportMANPATH=$MANPATH:$MANPAGE_dir

Then run the man command on gcloud manpages:

mangcloudinfo
NOTES
This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudtopicoffline-help
gcloudalphatopicoffline-help

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-22 UTC.