History

jolheiser 4a13872104 Generate docs as READMEs for examples Signed-off-by: jolheiser <john.olheiser@gmail.com>		2021-10-30 16:52:53 -05:00
..
README.md	Generate docs as READMEs for examples	2021-10-30 16:52:53 -05:00
main.go	Generate docs as READMEs for examples	2021-10-30 16:52:53 -05:00

README.md

myapp

myapp
├─ sub1
├─ sub2
│  ├─ sub3
│  │  └─ sub4
│  └─ sub5
└─ sub6

[--help]
[--myapp-bool-flag-f]
[--myapp-bool-flag-t]
[--myapp-duration-flag]=[value]
[--myapp-duration-flag-default]=[value]
[--myapp-int-flag]=[value]
[--myapp-int-flag-default]=[value]
[--myapp-string-flag]=[value]
[--myapp-string-flag-default]=[value]

Usage:

myapp [FLAGS] [ARGS...]

--help: Show help

--myapp-bool-flag-f: Bool flag false

--myapp-bool-flag-t: Bool flag true (default: true)

--myapp-duration-flag="": Duration flag with no default

--myapp-duration-flag-default="": Duration flag with default (default: 5m0s)

--myapp-int-flag="": Int flag with no default

--myapp-int-flag-default="": Int flag with default (default: 100)

--myapp-string-flag="": String flag with no default

--myapp-string-flag-default="": String flag with default (default: string default)

sub1

[--help]
[--sub1-bool-flag-f]
[--sub1-bool-flag-t]
[--sub1-duration-flag]=[value]
[--sub1-duration-flag-default]=[value]
[--sub1-int-flag]=[value]
[--sub1-int-flag-default]=[value]
[--sub1-string-flag]=[value]
[--sub1-string-flag-default]=[value]

Usage:

root [FLAGS] sub1 [FLAGS] [ARGS...]

--help: Show help

--sub1-bool-flag-f: Bool flag false

--sub1-bool-flag-t: Bool flag true (default: true)

--sub1-duration-flag="": Duration flag with no default

--sub1-duration-flag-default="": Duration flag with default (default: 5m0s)

--sub1-int-flag="": Int flag with no default

--sub1-int-flag-default="": Int flag with default (default: 100)

--sub1-string-flag="": String flag with no default

--sub1-string-flag-default="": String flag with default (default: string default)

sub2

Short help

[--help]
[--sub2-bool-flag-f]
[--sub2-bool-flag-t]
[--sub2-duration-flag]=[value]
[--sub2-duration-flag-default]=[value]
[--sub2-int-flag]=[value]
[--sub2-int-flag-default]=[value]
[--sub2-string-flag]=[value]
[--sub2-string-flag-default]=[value]

Usage:

root [FLAGS] sub2 [FLAGS] [ARGS...]

--help: Show help

--sub2-bool-flag-f: Bool flag false

--sub2-bool-flag-t: Bool flag true (default: true)

--sub2-duration-flag="": Duration flag with no default

--sub2-duration-flag-default="": Duration flag with default (default: 5m0s)

--sub2-int-flag="": Int flag with no default

--sub2-int-flag-default="": Int flag with default (default: 100)

--sub2-string-flag="": String flag with no default

--sub2-string-flag-default="": String flag with default (default: string default)

sub3

Long help

[--help]
[--sub3-bool-flag-f]
[--sub3-bool-flag-t]
[--sub3-duration-flag]=[value]
[--sub3-duration-flag-default]=[value]
[--sub3-int-flag]=[value]
[--sub3-int-flag-default]=[value]
[--sub3-string-flag]=[value]
[--sub3-string-flag-default]=[value]

Usage:

root [FLAGS] sub2 [FLAGS] sub3 [FLAGS] [ARGS...]

--help: Show help

--sub3-bool-flag-f: Bool flag false

--sub3-bool-flag-t: Bool flag true (default: true)

--sub3-duration-flag="": Duration flag with no default

--sub3-duration-flag-default="": Duration flag with default (default: 5m0s)

--sub3-int-flag="": Int flag with no default

--sub3-int-flag-default="": Int flag with default (default: 100)

--sub3-string-flag="": String flag with no default

--sub3-string-flag-default="": String flag with default (default: string default)

sub4

[--help]
[--sub4-bool-flag-f]
[--sub4-bool-flag-t]
[--sub4-duration-flag]=[value]
[--sub4-duration-flag-default]=[value]
[--sub4-int-flag]=[value]
[--sub4-int-flag-default]=[value]
[--sub4-string-flag]=[value]
[--sub4-string-flag-default]=[value]

Usage:

sub4 [FLAGS] [ARGS...]

--help: Show help

--sub4-bool-flag-f: Bool flag false

--sub4-bool-flag-t: Bool flag true (default: true)

--sub4-duration-flag="": Duration flag with no default

--sub4-duration-flag-default="": Duration flag with default (default: 5m0s)

--sub4-int-flag="": Int flag with no default

--sub4-int-flag-default="": Int flag with default (default: 100)

--sub4-string-flag="": String flag with no default

--sub4-string-flag-default="": String flag with default (default: string default)

sub5

[--help]
[--sub5-bool-flag-f]
[--sub5-bool-flag-t]
[--sub5-duration-flag]=[value]
[--sub5-duration-flag-default]=[value]
[--sub5-int-flag]=[value]
[--sub5-int-flag-default]=[value]
[--sub5-string-flag]=[value]
[--sub5-string-flag-default]=[value]

Usage:

sub5 [FLAGS] [ARGS...]

--help: Show help

--sub5-bool-flag-f: Bool flag false

--sub5-bool-flag-t: Bool flag true (default: true)

--sub5-duration-flag="": Duration flag with no default

--sub5-duration-flag-default="": Duration flag with default (default: 5m0s)

--sub5-int-flag="": Int flag with no default

--sub5-int-flag-default="": Int flag with default (default: 100)

--sub5-string-flag="": String flag with no default

--sub5-string-flag-default="": String flag with default (default: string default)

sub6

[--help]
[--sub6-bool-flag-f]
[--sub6-bool-flag-t]
[--sub6-duration-flag]=[value]
[--sub6-duration-flag-default]=[value]
[--sub6-int-flag]=[value]
[--sub6-int-flag-default]=[value]
[--sub6-string-flag]=[value]
[--sub6-string-flag-default]=[value]

Usage:

sub6 [FLAGS] [ARGS...]

--help: Show help

--sub6-bool-flag-f: Bool flag false

--sub6-bool-flag-t: Bool flag true (default: true)

--sub6-duration-flag="": Duration flag with no default

--sub6-duration-flag-default="": Duration flag with default (default: 5m0s)

--sub6-int-flag="": Int flag with no default

--sub6-int-flag-default="": Int flag with default (default: 100)

--sub6-string-flag="": String flag with no default

--sub6-string-flag-default="": String flag with default (default: string default)