gcloud preview help - search gcloud help text

gcloud preview help[COMMAND …][--filter=EXPRESSION][--limit=LIMIT; default=5][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]; default="~relevance"][GCLOUD_WIDE_FLAG …][--SEARCH_TERMS …]

Otherwise, gcloud preview help runs a search for all commands with help textmatching the given argument or arguments. It prints the command name and asummary of the help text for any command that it finds as a result.

To run a search directly, you can use remainder arguments, following a--.

By default, command results are displayed in a table that shows the name of thecommand and snippets of the help text that relate to your search terms.

By default, search results are sorted from most to least relevant by default,using a localized rating based on several heuristics. These heuristics maychange in future runs of this command.

gcloudpreviewhelpprojectsdescribe

To search for all commands whose help text contains the wordproject, run:

gcloudpreviewhelp--project

To search for commands whose help text contains the wordprojectand the string--foo, run:

gcloudpreviewhelp--project--foo

To search and receive more than the default limit of 5 search results, run:

gcloudpreviewhelp--limit=20--project

To search for a term and sort the results by a different characteristic, such ascommand name, run:

gcloudpreviewhelp--sort-by=name--project

[COMMAND …]

Sequence of names representing a gcloud group or command name.

If the arguments provide the name of a gcloud command, the full help text ofthat command will be displayed. Otherwise, all arguments will be consideredsearch terms and used to search through all of gcloud's help text.

[--SEARCH_TERMS …]

Search terms. The command will return a list of gcloud commands that arerelevant to the searched term. If this argument is provided, the command willalways return a list of search results rather than displaying help text of asingle command.

For example, to search for commands that relate to the termprojectorfolder, run:

gcloudpreviewhelp--projectfolder

The '--' argument must be specified between gcloud specific args on the left andSEARCH_TERMS on the right.

--filter=EXPRESSION

Apply a Boolean filterEXPRESSION to each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.

--limit=LIMIT; default=5

Maximum number of resources to list. The default is5. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.

--page-size=PAGE_SIZE

Some services group resource list output into pages. This flag specifies themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it isunlimited (no paging).Paging may be applied before or after--filter and--limit depending on the service.

--sort-by=[FIELD,…]; default="~relevance"

Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. The default is~relevance.

Run$gcloud help for details.