[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["難以理解","hardToUnderstand","thumb-down"],["資訊或程式碼範例有誤","incorrectInformationOrSampleCode","thumb-down"],["缺少我需要的資訊/範例","missingTheInformationSamplesINeed","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間：2025-09-04 (世界標準時間)。"],[[["\u003cp\u003eThe \u003ccode\u003egdcloud\u003c/code\u003e CLI follows a set of conventions for command design, with detailed information available via the \u003ccode\u003e--help\u003c/code\u003e flag for each command.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egdcloud\u003c/code\u003e commands are structured hierarchically, with groups and commands organized in a tree, and the general form of a command is \u003ccode\u003egdcloud GROUP GROUP ... COMMAND POSITIONAL ... FLAG ...\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003ePositional arguments must be provided in the order specified, while flag arguments, which are prefixed with \u003ccode\u003e--\u003c/code\u003e, can be intermixed but are typically displayed after positionals.\u003c/p\u003e\n"],["\u003cp\u003eOutput is to standard out for command results, where the \u003ccode\u003e--format\u003c/code\u003e flag can be used to specify the output format, and standard error is for diagnostics, with the exit status being \u003ccode\u003e0\u003c/code\u003e for success and any other number for an error.\u003c/p\u003e\n"],["\u003cp\u003eRepeating a flag will use the last value specified, and boolean flags may default to true or false, with the presence of \u003ccode\u003e--flag\u003c/code\u003e changing their state accordingly.\u003c/p\u003e\n"]]],[],null,["# gdcloud topic command-conventions\n\nNAME\n----\n\ngdcloud topic command-conventions - Supplementary help for gdcloud command-conventions.\n\nDESCRIPTION\n-----------\n\nThe gdcloud CLI command design follows a common set of principles and conventions. This document describes them in detail.\n\nConventions are goals rather than rules. For any exceptions, refer to the information provided for individual commands by using the `--help` flag.\n\nCOMMAND HIERARCHY\n-----------------\n\ngdcloud CLI commands are organized as a tree with gdcloud at the root, command groups in the inner nodes, and commands at the leaf nodes. Group commands are executable, but only for displaying the help text.\nAll groups and commands have a `--help` flag that displays the help text as standard output. The help text is derived from the running executable, so they are always up-to-date, even when switching between multiple release installations.\n\nCOMMAND LINE\n------------\n\nEvery gdcloud command follows the same form \n\n gdcloud GROUP GROUP ... COMMAND POSITIONAL ... FLAG ...\n\nFlag and positional arguments can be intermixed, but for consistency, positionals are usually displayed first in order, followed by flags in any order.\n\nCOMMAND USAGE NOTATION\n----------------------\n\nCommand usage is a shorthand notation that contains the full command name, the positional arguments, and the flag arguments in group sorted order. Optional arguments are enclosed in `[ ... ]`. For example \n\n gdcloud foo bar NAME [--format=FORMAT]\n\nThis is the usage for the `gdcloud foo bar` command with a required `NAME` positional argument, an optional `EXTRA` positional argument, and an optional `--format` flag argument.\n\nPositional Arguments\n--------------------\n\nPositional arguments are ordered and must be specified in the order listed in the command usage and help document argument definition list.\n\nFlag Arguments\n--------------\n\nFlag names are lowercase with a `--` prefix. Multi-word flags use `-` (hyphen/dash) as a word separator.\nFollowing UNIX convention, if a flag is repeated on the command line, then only the rightmost occurrence takes effect. No diagnostic is emitted. This makes it easy to set up command aliases and wrapper scripts that provide default flag values; values that can easily be overridden by specifying them on the alias or wrapper script command line.\n\nBoolean Flags\n-------------\n\nWhile many boolean flags have an implied value of `false`, some are `true` by default. The presence of `--flag` sets the flag to `true` or `false`, depending on the value implied by the name of the flag.\n\nValued Flags\n------------\n\nNon-boolean flags have an explicit value. The value can be specified by placing the value as the next argument after the flag `--flag value`.\n\nIf the value is an integer, then it must be `0` or above. Negative integers are not accepted.\n\nOutput\n------\n\nThe standard output is for explicit information requested by the command.\nDepending on the context, there might be guarantees on the output format to support deterministic parsing. Certain commands do return resources and these resources are listed as standard output usually using either a command-specific table format or the default YAML format. Moreover, the `--format` flag can be used to change or configure these default output formats. The `yaml`, `json`, and `csv` output `--format` values guarantee that successful command completion results in standard output data that can be parsed using the respective format. A detailed explanation of the capabilities of the `--format` flag can be found with the `gdcloud topic formats` command. For commands that do not return resources, the output is defined in the command's `--help` flag.\nThe standard error is reserved for diagnostics. In general, the format of standard error data might change from release to release. Users must not script against specific content, or even the existence of output to the standard error at all. The only reliable error indicator is the exit status.\nNo gdcloud CLI commands should crash with an uncaught exception. However, if the gdcloud CLI does crash, the stack trace is intercepted and written to the log file, and a crash diagnostic is written to the standard error.\n\nExit Status\n-----------\n\nExit status `0` indicates success. Any other exit status indicates an error. Command-specific diagnostics will explain the nature of the error and how to correct it."]]
