Skip to content

Add a demo based on the example in README.md and fix the example #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tdewolff merged 2 commits into from
Mar 20, 2025
Merged

Add a demo based on the example in README.md and fix the example #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
838c470
Add demo
dbohdan Mar 19, 2025
c1499bb
Fix example in README.md
dbohdan Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,24 +45,27 @@ import (
## Examples
### Default usage
A regular command with short and long options.
See [`cmd/test/main.go`](cmd/test/main.go).

```go
package main

import "github.com/tdewolff/argp"

func main() {
var verbose bool
var verbose int
var input string
var output string
var files []string
size := 512 // default value

argp := argp.New("CLI tool description")
argp.AddOpt(argp.Count{&verbose}, "v", "verbose", "Increase verbosity, eg. -vvv")
argp.AddOpt(&output, "o", "output", "Output file name")
argp.AddOpt(&size, "", "size", "Image size")
argp.AddArg(&input, "input", "Input file name")
argp.AddRest(&files, "files", "Additional input files")
argp.Parse()
cmd := argp.New("CLI tool description")
cmd.AddOpt(argp.Count{&verbose}, "v", "verbose", "Increase verbosity, eg. -vvv")
cmd.AddOpt(&output, "o", "output", "Output file name")
cmd.AddOpt(&size, "", "size", "Image size")
cmd.AddArg(&input, "input", "Input file name")
cmd.AddRest(&files, "files", "Additional files")
cmd.Parse()

// ...
}
Expand All @@ -71,13 +74,17 @@ func main() {
with help output

```
Usage: test [options]
Usage: test [options] input files...

Options:
-h, --help Help
-o, --output Output file name
--size Image size
-v, --verbose
-h, --help Help
-o, --output string Output file name
--size=512 int Image size
-v, --verbose int Increase verbosity, eg. -vvv

Arguments:
input Input file name
files Additional files
```

### Sub commands
Expand Down
36 changes: 36 additions & 0 deletions cmd/test/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package main

import (
"fmt"

"github.com/tdewolff/argp"
)

func main() {
var verbose int
var input string
var output string
var files []string
size := 512 // default value

cmd := argp.New("CLI tool description")
cmd.AddOpt(argp.Count{&verbose}, "v", "verbose", "Increase verbosity, eg. -vvv")
cmd.AddOpt(&output, "o", "output", "Output file name")
cmd.AddOpt(&size, "", "size", "Image size")
cmd.AddArg(&input, "input", "Input file name")
cmd.AddRest(&files, "files", "Additional files")
cmd.Parse()

fmt.Printf("verbose: %v\n", verbose)
fmt.Printf("input: %q\n", input)
fmt.Printf("output: %q\n", output)
fmt.Printf("size: %v\n", size)
fmt.Printf("files: []string{")
for i, file := range files {
if i > 0 {
fmt.Print(", ")
}
fmt.Printf("%q", file)
}
fmt.Println("}")
}