Commit Graph

69 Commits

Author SHA1 Message Date
Alex Flint b13a62172a update api docs for Parser.Parse 2024-09-05 17:15:02 -04:00
Alex Flint 7fd624cf1c add info to README about programmatically reproducing behavior of MustParse 2024-09-04 10:27:34 -04:00
Alex Flint 0cc152dce5
Merge pull request #224 from hhromic/better-version-v2
Fix usage writing when using custom version flag
2024-06-30 12:27:39 -04:00
Alex Flint b6422dcbc3
Merge pull request #233 from testwill/typo
fix: typo
2024-06-30 10:32:09 -04:00
Hugo Hromic c087d71802
Add note for version flag overriding to README 2024-06-30 00:13:28 +01:00
James Shubin 84ddf1d244 add an example for environment vars with arg names
If you want to specify both of these, and if they should have different
names, then this shows you how it can be done.
2024-02-28 22:29:16 -05:00
guoguangwu 582e6d537a fix: typo
Signed-off-by: guoguangwu <guoguangwu@magic-shield.com>
2023-11-15 17:58:55 +08:00
Sebastiaan Pasterkamp c8b9567d1b Feat: Add epilog after help text
Similar to the Description at the top of the
help text an Epilog is added at the bottom.

Resolves #189
2022-09-17 12:55:00 +02:00
Sebastiaan Pasterkamp a87d80089a Add 'IgnoreDefault' option 2022-01-02 15:17:09 +01:00
Alex Flint 0f0b4b5c3f
Update README.md 2021-09-18 08:50:33 -07:00
evgenv123 b157e8d10a
Update README.md
Hi! As a first-time user of your great package I got a little bit confused on using command line args and env vars together, so it took me some time to make testing and I propose to save this time for other people by adding relevant edits to README.md
2021-09-18 22:23:26 +07:00
Alex Flint 3d59e5e89e bump go-scalar to v1.1 and add documentation about supported types 2021-08-20 19:52:48 -07:00
Alex Flint 91214e01ea add an example of parsing into a map to the readme 2021-04-19 13:59:00 -07:00
Andrew Morozko 04c3fdbd80 Updated readme 2020-12-20 03:07:18 +03:00
Alex Flint c47edd0324 add documentation and examples showing how to override the short and long option names together 2020-08-06 16:41:45 -07:00
Alex Flint 2bc58b597b replace coveralls badge with codecov 2020-04-17 16:37:00 -04:00
Alex Flint 7a71aa1b20 add banner image 2020-04-17 16:09:24 -04:00
Alex Flint 388f831e68 drop golangci since it is shutting down soon; fix pkg.go.dev link 2020-04-17 16:00:32 -04:00
Alex Flint 40ed78b0fa use go.dev badge 2020-04-17 15:58:00 -04:00
Alex Flint efbf84df4c drop blank lines 2020-04-17 15:54:02 -04:00
Alex Flint 499991fce1 move some stuff around in the readme header; add sourcegraph 2020-04-17 15:52:34 -04:00
Alex Flint 1fc1a6f6df put coverage badge back 2020-04-03 12:28:05 -04:00
Alex Flint 9fccfd3d6a replace travis badge with github actions badge 2020-04-03 12:24:39 -04:00
Alex Flint 7ac7956369 drop coverage badge (adding an issue to put it back) 2020-04-03 11:59:47 -04:00
Alex Flint db9f869c99
Document that the placeholder tag requires v1.3.0 2020-02-23 11:44:00 -08:00
Marco Molteni 5943b1ad42 README: how to terminate a program when no subcommands are specified
Fixes #103
2020-01-23 18:16:28 +01:00
Andrew Morozko 9d4521ce8b Final improvements 2019-11-30 22:31:08 +03:00
Andrew Morozko c3a019cdb8 Various changes 2019-11-30 00:22:21 +03:00
Alex Flint e0fc08f7ad add docs about old way of specifying defaults 2019-10-21 23:37:12 -07:00
Alex Flint 7ac060af18 update documentation to new way of specifying defaults 2019-10-21 23:13:41 -07:00
Alex Flint e6003d3b6a add subcommands to readme 2019-08-06 16:41:50 -07:00
Alex Flint 42c2ab5ac6
Merge pull request #78 from alexflint/readme-spelling
minor fixes to readme
2019-04-14 17:18:01 -07:00
Alex Flint 891a07ec29 more tweaks 2019-04-14 16:08:51 -07:00
Alex Flint e56211335f minor fixes to readme 2019-04-14 16:06:27 -07:00
Alex Flint 1ec799ffcf update link for golangci badge 2019-04-04 09:18:22 -07:00
Alex Flint 6b4ab7355c add golangci badge, and fix some lint issues found by the tool 2019-04-04 09:10:24 -07:00
Pavel Borzenkov a6af419fff README: update TextUnmarshaler example
Values are much more convenient to use in argument structs, so update
README to use them instead of pointers in the example as we now support
this.

Signed-off-by: Pavel Borzenkov <pavel.borzenkov@gmail.com>
2018-11-20 12:32:32 +03:00
Illia Volochii fa5fe315f8 Change format from JSON to CSV 2018-05-01 12:02:44 +03:00
Illia Volochii 75bf1a1525 Fix providing multiple values via environment variables 2018-04-26 21:10:44 +03:00
Wlazlo, Matt 51337ded77 fixed example comment, test coverage issue 2018-04-16 11:07:48 +10:00
Wlazlo, Matt d4cc703210 Custom parsers implementing encoding.TextMarshaler() can have default values printed via --help 2018-04-13 14:46:24 +10:00
Rick ba9514f0be Further clarification 2017-10-02 14:36:23 +01:00
Rick d7961941f0 Altered help tag parsing to reduce the constraints on help text content; old behaviour is retained for backward compatibility 2017-10-02 14:18:41 +01:00
K3A b413f8dfb0 Merge branch 'master' into master 2017-03-09 18:25:56 +01:00
Mario Hros 9e6f80aa90 readme update 2017-03-08 20:52:02 +01:00
Kenneth Shaw d4c2b35b2e Adding separate tag option
As outlined in #49, there is a need to mimic the behavior of other
applications by interweaving positional and non-positional parameters.

This change adds the 'separate' option that will force a arg of type
[]string to only read the next supplied value.

For example, when dealing with the following arg type:

var MyArgs struct {
    Pos []string `arg:"positional"`
    Separate []string `arg:"-s,separate"`
}

This commit will parse the following command line:

./app pos1 pos2 -s=separate1 -s=separate2 pos3 -s=separate3 pos4

Such that MyArgs.Pos will be [pos1 pos2 pos3 pos4] and MyArgs.Separate
will be [separate1 separate2 separate3].

Unit tests for the above have also been written and are included in this
commit, as well as the addition of a section to README.md and an example
func in example_test.go.

Fixes #49
2017-03-04 09:13:12 +07:00
Emmanouil "Manolis" Maragkakis db27431153 add support for description string 2017-01-23 20:41:12 -05:00
Alex Flint 03900620e2 add not on embedding to readme 2016-10-10 10:52:42 +10:30
Alex Flint f882700b72 add to readme 2016-09-08 21:26:12 -07:00
Alex Flint 6e9648cac6 add goreportcard to readme.md 2016-07-31 10:16:17 -07:00