Source file src/github.com/ory/x/cmdx/env.go

Documentation: github.com/ory/x/cmdx

     1  package cmdx
     2  
     3  // EnvVarExamplesHelpMessage returns a string containing documentation on how to use environment variables.
     4  func EnvVarExamplesHelpMessage(name string) string {
     5  	return `This command exposes a variety of controls via environment variables. Here are some examples on how to
     6  configure environment variables:
     7  
     8  Linux / macOS:
     9  	$ export FOO=bar
    10  	$ export BAZ=bar
    11  	$ ` + name + ` ...
    12  
    13  	$ FOO=bar BAZ=bar ` + name + ` ...
    14  
    15  Docker:
    16  	$ docker run -e FOO=bar -e BAZ=bar ...
    17  
    18  Windows (cmd):
    19  	> set FOO=bar
    20  	> set BAZ=bar
    21  	> ` + name + ` ...
    22  
    23  Windows (powershell):
    24  	> $env:FOO = "bar"
    25  	> $env:BAZ = "bar"
    26  	> ` + name + `
    27  `
    28  }
    29  

View as plain text