|
| 1 | +--- |
| 2 | +title: Arguments |
| 3 | +draft: false |
| 4 | +weight: 4 |
| 5 | +prev: /docs/cli/flags |
| 6 | +next: /docs/cli/help |
| 7 | +--- |
| 8 | + |
| 9 | +# Comprehensive Guide to Argument Handling in Golly's CLI Package |
| 10 | + |
| 11 | +In command-line interfaces (CLIs), **arguments** are essential for passing inputs to commands. These inputs, which are distinct from flags, typically consist of filenames, paths, or other necessary data required by the command to perform its task. The Golly `cli` package provides robust support for handling arguments, making it simple to manage both required and optional arguments in your Go applications. |
| 12 | + |
| 13 | +Lets explore how to handle arguments using the Golly `cli` package, covering everything from simple argument retrieval to advanced use cases. We will provide detailed examples to illustrate how you can leverage arguments effectively in your CLI application. |
| 14 | + |
| 15 | +## What Are Arguments in CLI? |
| 16 | + |
| 17 | +Arguments in a CLI application refer to positional parameters passed to a command when it is invoked. Unlike flags, which are prefixed by an identifier (e.g., `--flag`), arguments do not require a prefix and are typically listed after the command in the terminal. For example: |
| 18 | + |
| 19 | +```bash |
| 20 | +$ myapp greet John |
| 21 | +``` |
| 22 | + |
| 23 | +In this example, greet is the command, and John is an argument. |
| 24 | + |
| 25 | +Arguments are often required, though they can also be optional depending on the design of the CLI. The Golly cli package provides flexible handling of both required and optional arguments. |
| 26 | + |
| 27 | +### Basic Argument Handling |
| 28 | + |
| 29 | +To demonstrate basic argument handling, let’s create a simple CLI application that accepts a name as an argument and greets the user. |
| 30 | + |
| 31 | +#### Example: Greeting Command with One Argument |
| 32 | + |
| 33 | +```go |
| 34 | +package main |
| 35 | + |
| 36 | +import ( |
| 37 | + "fmt" |
| 38 | + "log" |
| 39 | + "os" |
| 40 | + "oss.nandlabs.io/golly/cli" |
| 41 | +) |
| 42 | + |
| 43 | +func main() { |
| 44 | + app := cli.NewApp() |
| 45 | + app.Name = "Greeter" |
| 46 | + app.Usage = "A simple CLI to greet users" |
| 47 | + |
| 48 | + // Define the action of the app |
| 49 | + app.Action = func(ctx *cli.Context) error { |
| 50 | + if ctx.Args().Len() > 0 { |
| 51 | + name := ctx.Args().Get(0) // Get the first argument |
| 52 | + fmt.Printf("Hello, %s!\n", name) |
| 53 | + } else { |
| 54 | + fmt.Println("Hello, World!") |
| 55 | + } |
| 56 | + return nil |
| 57 | + } |
| 58 | + |
| 59 | + if err := app.Execute(os.Args); err != nil { |
| 60 | + log.Fatal(err) |
| 61 | + } |
| 62 | +} |
| 63 | +``` |
| 64 | + |
| 65 | +In this Example: |
| 66 | + |
| 67 | +- We define a single argument (the user’s name) which is passed to the greet command. |
| 68 | +- We retrieve the argument using ctx.Args().Get(0), which gets the first positional argument. |
| 69 | +- If no arguments are provided, a default message (“Hello, World!”) is displayed. |
| 70 | + |
| 71 | +#### Running the Application |
| 72 | + |
| 73 | +$ go run main.go John |
| 74 | +Hello, John! |
| 75 | + |
| 76 | +$ go run main.go |
| 77 | +Hello, World! |
| 78 | + |
| 79 | +In the first command, John is passed as an argument, and the application greets John. In the second command, no arguments are passed, so the default greeting is shown. |
| 80 | + |
| 81 | +### Handling Multiple Arguments |
| 82 | + |
| 83 | +The Golly cli package supports multiple arguments. Let’s extend the previous example to handle two arguments: the user’s first name and last name. |
| 84 | + |
| 85 | +#### Example: Greeting with Multiple Arguments |
| 86 | + |
| 87 | +```go |
| 88 | +package main |
| 89 | + |
| 90 | +import ( |
| 91 | + "fmt" |
| 92 | + "log" |
| 93 | + "os" |
| 94 | + "oss.nandlabs.io/golly/cli" |
| 95 | +) |
| 96 | + |
| 97 | +func main() { |
| 98 | + app := cli.NewApp() |
| 99 | + app.Name = "Greeter" |
| 100 | + app.Usage = "A simple CLI to greet users with full name" |
| 101 | + |
| 102 | + // Define the action of the app |
| 103 | + app.Action = func(ctx *cli.Context) error { |
| 104 | + if ctx.Args().Len() >= 2 { |
| 105 | + firstName := ctx.Args().Get(0) // First argument |
| 106 | + lastName := ctx.Args().Get(1) // Second argument |
| 107 | + fmt.Printf("Hello, %s %s!\n", firstName, lastName) |
| 108 | + } else { |
| 109 | + fmt.Println("Please provide both first and last name") |
| 110 | + } |
| 111 | + return nil |
| 112 | + } |
| 113 | + |
| 114 | + if err := app.Execute(os.Args); err != nil { |
| 115 | + log.Fatal(err) |
| 116 | + } |
| 117 | +} |
| 118 | +``` |
| 119 | + |
| 120 | +In this example: |
| 121 | + |
| 122 | +- The application expects two arguments: the first name and the last name. |
| 123 | +- If two arguments are provided, the application prints the full name. |
| 124 | +- If fewer than two arguments are provided, an error message is shown. |
| 125 | + |
| 126 | +#### Running the Application |
| 127 | + |
| 128 | +```bash |
| 129 | +$ go run main.go John Doe |
| 130 | +Hello, John Doe! |
| 131 | + |
| 132 | +$ go run main.go John |
| 133 | +Please provide both first and last name |
| 134 | +``` |
| 135 | + |
| 136 | +### Argument Validation |
| 137 | + |
| 138 | +The Golly cli package allows you to validate arguments before proceeding with command execution. You can check for the presence, length, or format of arguments. Let’s modify the previous example to validate that only alphabetic characters are allowed in the arguments. |
| 139 | + |
| 140 | +#### Example: Validating Arguments |
| 141 | + |
| 142 | +```go |
| 143 | +package main |
| 144 | + |
| 145 | +import ( |
| 146 | + "fmt" |
| 147 | + "log" |
| 148 | + "os" |
| 149 | + "regexp" |
| 150 | + "oss.nandlabs.io/golly/cli" |
| 151 | +) |
| 152 | + |
| 153 | +func isValidName(name string) bool { |
| 154 | + regex := regexp.MustCompile(`^[a-zA-Z]+$`) |
| 155 | + return regex.MatchString(name) |
| 156 | +} |
| 157 | + |
| 158 | +func main() { |
| 159 | + app := cli.NewApp() |
| 160 | + app.Name = "Greeter" |
| 161 | + app.Usage = "A simple CLI to greet users with validated names" |
| 162 | + |
| 163 | + app.Action = func(ctx *cli.Context) error { |
| 164 | + if ctx.Args().Len() >= 2 { |
| 165 | + firstName := ctx.Args().Get(0) |
| 166 | + lastName := ctx.Args().Get(1) |
| 167 | + |
| 168 | + if !isValidName(firstName) || !isValidName(lastName) { |
| 169 | + fmt.Println("Invalid name: Only alphabetic characters are allowed.") |
| 170 | + return nil |
| 171 | + } |
| 172 | + |
| 173 | + fmt.Printf("Hello, %s %s!\n", firstName, lastName) |
| 174 | + } else { |
| 175 | + fmt.Println("Please provide both first and last name") |
| 176 | + } |
| 177 | + return nil |
| 178 | + } |
| 179 | + |
| 180 | + if err := app.Execute(os.Args); err != nil { |
| 181 | + log.Fatal(err) |
| 182 | + } |
| 183 | +} |
| 184 | +``` |
| 185 | + |
| 186 | +In this example, the isValidName function checks if the provided arguments are valid alphabetic names. If an invalid name is provided, the application displays an error message. |
| 187 | + |
| 188 | +### Handling Optional Arguments |
| 189 | + |
| 190 | +Sometimes, arguments are optional. You can define default behaviors when certain arguments are not provided. Let’s modify our application to allow for an optional title (e.g., Mr., Mrs., Dr.) before the name. |
| 191 | + |
| 192 | +#### Example: Handling Optional Arguments |
| 193 | + |
| 194 | +```go |
| 195 | +package main |
| 196 | + |
| 197 | +import ( |
| 198 | + "fmt" |
| 199 | + "log" |
| 200 | + "os" |
| 201 | + "oss.nandlabs.io/golly/cli" |
| 202 | +) |
| 203 | + |
| 204 | +func main() { |
| 205 | + app := cli.NewApp() |
| 206 | + app.Name = "Greeter" |
| 207 | + app.Usage = "A simple CLI to greet users with optional title" |
| 208 | + |
| 209 | + app.Action = func(ctx *cli.Context) error { |
| 210 | + var title, firstName, lastName string |
| 211 | + |
| 212 | + if ctx.Args().Len() == 3 { |
| 213 | + title = ctx.Args().Get(0) |
| 214 | + firstName = ctx.Args().Get(1) |
| 215 | + lastName = ctx.Args().Get(2) |
| 216 | + fmt.Printf("Hello, %s %s %s!\n", title, firstName, lastName) |
| 217 | + } else if ctx.Args().Len() == 2 { |
| 218 | + firstName = ctx.Args().Get(0) |
| 219 | + lastName = ctx.Args().Get(1) |
| 220 | + fmt.Printf("Hello, %s %s!\n", firstName, lastName) |
| 221 | + } else { |
| 222 | + fmt.Println("Please provide at least a first and last name") |
| 223 | + } |
| 224 | + return nil |
| 225 | + } |
| 226 | + |
| 227 | + if err := app.Execute(os.Args); err != nil { |
| 228 | + log.Fatal(err) |
| 229 | + } |
| 230 | +} |
| 231 | +``` |
| 232 | + |
| 233 | +In this example: |
| 234 | + |
| 235 | +- The application checks if a title is provided by counting the number of arguments. |
| 236 | +- If three arguments are provided, it assumes the first argument is the title and prints the full name with the title. |
| 237 | +- If two arguments are provided, it only prints the first and last name. |
| 238 | + |
| 239 | +#### Running the Application |
| 240 | + |
| 241 | +```go |
| 242 | +$ go run main.go Dr. John Doe |
| 243 | +Hello, Dr. John Doe! |
| 244 | + |
| 245 | +$ go run main.go John Doe |
| 246 | +Hello, John Doe! |
| 247 | +``` |
| 248 | + |
| 249 | +The Golly cli package provides comprehensive and flexible argument handling, enabling developers to build powerful and user-friendly command-line tools. Whether you’re dealing with simple, required arguments or more complex, optional inputs, the cli package makes argument management easy and intuitive. |
| 250 | + |
| 251 | +From basic retrieval to validation and optional argument handling, the package offers a range of tools to suit your application’s needs. Start building your CLI applications with confidence using Golly’s cli package and take advantage of its robust argument handling capabilities. |
| 252 | + |
| 253 | +For more information, check out the official [Golly CLI package documentation](https://pkg.go.dev/oss.nandlabs.io/golly/cli). |
0 commit comments