Merge pull request #237 from purpleidea/feat/env-docs

add an example for environment vars with arg names
This commit is contained in:
Alex Flint 2024-06-30 10:31:46 -04:00 committed by GitHub
commit 56ee7c97ac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 0 deletions

View File

@ -120,6 +120,23 @@ $ WORKERS='1,99' ./example
Workers: [1 99]
```
You can also have an environment variable that doesn't match the arg name:
```go
var args struct {
Workers int `arg:"--count,env:NUM_WORKERS"`
}
arg.MustParse(&args)
fmt.Println("Workers:", args.Workers)
```
```
$ NUM_WORKERS=6 ./example
Workers: 6
$ NUM_WORKERS=6 ./example --count 4
Workers: 4
```
### Usage strings
```go
var args struct {