summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSebastiaan Pasterkamp <[email protected]>2022-01-02 15:06:37 +0100
committerSebastiaan Pasterkamp <[email protected]>2022-01-02 15:17:09 +0100
commita87d80089a78b707d9e4fbd7061e54e7e834688d (patch)
treed0cf8e9ccc77b6ef99a1684117c1f233f781c823 /README.md
parentbf32f082479c88da7bcf4c4765a70e3a357d9dfc (diff)
Add 'IgnoreDefault' option
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index dab2996..7f1fdca 100644
--- a/README.md
+++ b/README.md
@@ -134,10 +134,10 @@ arg.MustParse(&args)
```shell
$ ./example -h
-Usage: [--verbose] [--dataset DATASET] [--optimize OPTIMIZE] [--help] INPUT [OUTPUT [OUTPUT ...]]
+Usage: [--verbose] [--dataset DATASET] [--optimize OPTIMIZE] [--help] INPUT [OUTPUT [OUTPUT ...]]
Positional arguments:
- INPUT
+ INPUT
OUTPUT
Options:
@@ -180,6 +180,24 @@ var args struct {
arg.MustParse(&args)
```
+#### Ignoring environment variables and/or default values
+
+The values in an existing structure can be kept in-tact by ignoring environment
+variables and/or default values.
+
+```go
+var args struct {
+ Test string `arg:"-t,env:TEST" default:"something"`
+}
+
+p, err := arg.NewParser(arg.Config{
+ IgnoreEnv: true,
+ IgnoreDefault: true,
+}, &args)
+
+err = p.Parse(os.Args)
+```
+
### Arguments with multiple values
```go
var args struct {