Skip to content

Commit

Permalink
Merge pull request #997 from drov0/patch-1
Browse files Browse the repository at this point in the history
Add timestampFlag docs
  • Loading branch information
coilysiren authored Jan 30, 2020
2 parents ffbb8c0 + 8a9326b commit fed41d6
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/v2/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ cli v2 manual
+ [Customization](#customization-1)
* [Version Flag](#version-flag)
+ [Customization](#customization-2)
* [Timestamp Flag](#timestamp-flag)
* [Full API Example](#full-api-example)

<!-- tocstop -->
Expand Down Expand Up @@ -1273,6 +1274,49 @@ func main() {
}
```

### Timestamp Flag

Using the timestamp flag is simple. Please refer to [`time.Parse`](https://golang.org/pkg/time/#example_Parse) to get possible formats.

<!-- {
"args": ["&#45;&#45;meeting", "2019-08-12T15:04:05"],
"output": "2019\\-08\\-12 15\\:04\\:05 \\+0000 UTC"
} -->
``` go
package main

import (
"fmt"
"log"
"os"

"github.com/urfave/cli/v2"
)

func main() {
app := &cli.App{
Flags: []cli.Flag {
&cli.TimestampFlag{Name: "meeting", Layout: "2006-01-02T15:04:05"},
},
Action: func(c *cli.Context) error {
fmt.Printf("%s", c.Timestamp("meeting").String())
return nil
},
}

err := app.Run(os.Args)
if err != nil {
log.Fatal(err)
}
}
```

In this example the flag could be used like this :

`myapp --meeting 2019-08-12T15:04:05`

Side note: quotes may be necessary around the date depending on your layout (if you have spaces for instance)

### Full API Example

**Notice**: This is a contrived (functioning) example meant strictly for API
Expand Down

0 comments on commit fed41d6

Please sign in to comment.