9456a4e922
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
32 lines
697 B
Go
32 lines
697 B
Go
// Copyright © 2023 Ory Corp
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package cmdx
|
|
|
|
// EnvVarExamplesHelpMessage returns a string containing documentation on how to use environment variables.
|
|
func EnvVarExamplesHelpMessage(name string) string {
|
|
return `This command exposes a variety of controls via environment variables. Here are some examples on how to
|
|
configure environment variables:
|
|
|
|
Linux / macOS:
|
|
$ export FOO=bar
|
|
$ export BAZ=bar
|
|
$ ` + name + ` ...
|
|
|
|
$ FOO=bar BAZ=bar ` + name + ` ...
|
|
|
|
Docker:
|
|
$ docker run -e FOO=bar -e BAZ=bar ...
|
|
|
|
Windows (cmd):
|
|
> set FOO=bar
|
|
> set BAZ=bar
|
|
> ` + name + ` ...
|
|
|
|
Windows (powershell):
|
|
> $env:FOO = "bar"
|
|
> $env:BAZ = "bar"
|
|
> ` + name + `
|
|
`
|
|
}
|