- NAME
-
- gcloud topic flags-file - --flags-file=YAML_FILE supplementary help
- DESCRIPTION
-
The
--flags-file
=YAML-FILE
flag, available to allgcloud
commands, supports complex flag values in any command interpreter.Complex flag values that contain command interpreter special characters may be difficult to specify on the command line. The combined list of
special
characters across commonly used command interpreters (shell, cmd.exe, PowerShell) is surprisingly large. Among them are", ', `, *, ?, [, ], (, ), $, %, #, ^, &, |, {, }, ;, \, <, >,
space
,tab
,newline
. Add to that the separator characters forlist
anddict
valued flags, and it becomes all but impossible to construct portable command lines.The
--flags-file
=YAML-FILE
flag solves this problem by allowing command line flags to be specified in a YAML/JSON file. String, numeric, list and dict flag values are specified using YAML/JSON notation and quoting rules.Flag specification uses dictionary notation. Use a list of dictionaries for flags that must be specified multiple times.
For example, this YAML file defines values for Boolean, integer, floating point, string, dictionary and list valued flags:
--boolean: --integer: 123 --float: 456.789 --string: A string value. --dictionary: a=b: c,d e,f: g=h i: none j=k=l: m=$n,o=%p "y:": ":z" meta: - key: foo value: bar - key: abc value: xyz --list: - a,b,c - x,y,z
If the file is named
my-flags.yaml
then the command line flag--flags-file=my-flags.yaml
will set the specified flags on any system using any command interpreter.--flags-file
may be specified in a YAML file, and its value can be a YAML list to reference multiple files.This example specifies the
--metadata
flag multiple times:- --metadata: abc --integer: 123 - --metadata: xyz
Each
--flags-file
arg is replaced by its contents, so normal flag precedence applies. For example, givenflags-1.yaml
:--zone: us-east2-a
flags-2.yaml
:--verbosity: info --zone: us-central1-a
and command line:
gcloud compute instances describe \ --flags-file=flags-1.yaml my-instance --flags-file=flags-2.yaml
the effective command line is:
gcloud compute instances describe \ --zone=us-east2-a my-instance --verbosity=info --zone=us-central1-a
using zone
us-central1-a
(notus-east2-a
, becauseflags-2.yaml
, to the right offlags-1.yaml
, has higher precedence). - NOTES
-
These variants are also available:
gcloud alpha topic flags-file
gcloud beta topic flags-file
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{
"last_modified": "Last updated 2024-02-06 UTC.",
"state": ""
}