1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
---
tags:
- v3
search:
boost: 2
---
The [Basics] showed how to access arguments for a command. They are all retrieved as strings which is fine
but it we need to say get integers or timestamps the user would have to convert from string to desired type.
To ease the burden on users the `cli` library offers predefined `{Type}Arg` and `{Type}Args` structure to faciliate this
The value of the argument can be retrieved using the `command.{Type}Arg()` function. For e.g
<!-- {
"args" : ["10"],
"output": "We got 10"
} -->
```go
package main
import (
"fmt"
"log"
"os"
"context"
"github.com/urfave/cli/v3"
)
func main() {
cmd := &cli.Command{
Arguments: []cli.Argument{
&cli.IntArg{
Name: "someint",
},
},
Action: func(ctx context.Context, cmd *cli.Command) error {
fmt.Printf("We got %d", cmd.IntArg("someint"))
return nil
},
}
if err := cmd.Run(context.Background(), os.Args); err != nil {
log.Fatal(err)
}
}
```
Running this program with an argument gives the following output
```sh-session
$ greet 10
We got 10
```
Instead of using the `cmd.{Type}Arg()` function to retrieve the argument value a destination for the argument can be set
for e.g
<!-- {
"args" : ["25"],
"output": "We got 25"
} -->
```go
package main
import (
"fmt"
"log"
"os"
"context"
"github.com/urfave/cli/v3"
)
func main() {
var ival int
cmd := &cli.Command{
Arguments: []cli.Argument{
&cli.IntArg{
Name: "someint",
Destination: &ival,
},
},
Action: func(ctx context.Context, cmd *cli.Command) error {
fmt.Printf("We got %d", ival)
return nil
},
}
if err := cmd.Run(context.Background(), os.Args); err != nil {
log.Fatal(err)
}
}
```
Some of the basic types arguments suported are
- `FloatArg`
- `IntArg`
- `Int8Arg`
- `Int16Arg`
- `Int32Arg`
- `Int64Arg`
- `StringArg`
- `UintArg`
- `Uint8Arg`
- `Uint16Arg`
- `Uint32Arg`
- `Uint64Arg`
- `TimestampArg`
This is ok for single value arguments. Any number of these single value arguments can be concatenated in the `Arguments`
slice field of `Command`.
The library also support multi value arguments for e.g
<!-- {
"args" : ["10", "20"],
"output": "We got [10 20]"
} -->
```go
package main
import (
"fmt"
"log"
"os"
"context"
"github.com/urfave/cli/v3"
)
func main() {
cmd := &cli.Command{
Arguments: []cli.Argument{
&cli.IntArgs{
Name: "someint",
Min: 0,
Max: -1,
},
},
Action: func(ctx context.Context, cmd *cli.Command) error {
fmt.Println("We got ", cmd.IntArgs("someint"))
return nil
},
}
if err := cmd.Run(context.Background(), os.Args); err != nil {
log.Fatal(err)
}
}
```
Some things to note about multi value arguments
1. They are of `{Type}Args` type rather than `{Type}Arg` to differentiate them from single value arguments
2. The `Max` field needs to be defined to a non zero value without which it cannot be parsed
3. `Max` field value needs to be greater than the `Min` field value
As with single value args the destination field can be set
<!-- {
"args" : ["10", "30"],
"output": "We got [10 30]"
} -->
```go
package main
import (
"fmt"
"log"
"os"
"context"
"github.com/urfave/cli/v3"
)
func main() {
var ivals []int
cmd := &cli.Command{
Arguments: []cli.Argument{
&cli.IntArgs{
Name: "someint",
Min: 0,
Max: -1,
Destination: &ivals,
},
},
Action: func(ctx context.Context, cmd *cli.Command) error {
fmt.Println("We got ", ivals)
return nil
},
}
if err := cmd.Run(context.Background(), os.Args); err != nil {
log.Fatal(err)
}
}
```
Following multi value arguments are supported
- `FloatArgs`
- `IntArgs`
- `Int8Args`
- `Int16Args`
- `Int32Args`
- `Int64Args`
- `StringArgs`
- `UintArgs`
- `Uint8Args`
- `Uint16Args`
- `Uint32Args`
- `Uint64Args`
- `TimestampArgs`
It goes without saying that the chain of arguments set in the Arguments slice need to be consistent. Generally a glob
argument(`max=-1`) should be set for the argument at the end of the slice. To glob args we arent interested in we coud add
the following to the end of the Arguments slice and retrieve them as a slice
```
&StringArgs{
Max: -1,
},
```
|