Files
coder/scripts/clidocgen/command.tpl
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

59 lines
1.0 KiB
Smarty
Raw Normal View History

2023-02-22 19:53:21 -06:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
2023-03-23 17:42:20 -05:00
# {{ fullName . }}
{{ with .Short }}
{{ . }}
2023-02-22 19:53:21 -06:00
{{ end }}
2023-03-23 17:42:20 -05:00
{{ with .Aliases }}
Aliases:
{{- range $index, $alias := . }}
* {{ $alias }}
{{- end }}
{{ end }}
{{- if .Use }}
2023-02-22 19:53:21 -06:00
## Usage
```console
2023-03-23 17:42:20 -05:00
{{ .FullUsage }}
2023-02-22 19:53:21 -06:00
```
{{end}}
2023-03-23 17:42:20 -05:00
{{- if .Long}}
## Description
2023-02-22 19:53:21 -06:00
```console
2023-03-23 17:42:20 -05:00
{{.Long}}
2023-02-22 19:53:21 -06:00
```
{{end}}
2023-03-23 17:42:20 -05:00
{{- range $index, $cmd := visibleSubcommands . }}
2023-02-22 19:53:21 -06:00
{{- if eq $index 0 }}
## Subcommands
| Name | Purpose |
| ---- | ----- |
{{- end }}
| [{{ $cmd.Name | wrapCode }}](./{{commandURI $cmd}}) | {{ $cmd.Short }} |
2023-02-22 19:53:21 -06:00
{{- end}}
{{ "" }}
2023-03-23 17:42:20 -05:00
{{- range $index, $opt := visibleOptions . }}
2023-02-22 19:53:21 -06:00
{{- if eq $index 0 }}
2023-03-23 17:42:20 -05:00
## Options
2023-02-22 19:53:21 -06:00
{{- end }}
2023-03-23 17:42:20 -05:00
### {{ with $opt.FlagShorthand}}-{{ . }}, {{end}}--{{ $opt.Flag }}
{{" "}}
{{ tableHeader }}
2024-08-20 14:47:46 +10:00
| Type | {{ typeHelper $opt | wrapCode }} |
2023-03-23 17:42:20 -05:00
{{- with $opt.Env }}
| Environment | {{ (print "$" .) | wrapCode }} |
2023-02-22 19:53:21 -06:00
{{- end }}
2023-04-07 17:58:21 -05:00
{{- with $opt.YAMLPath }}
| YAML | {{ . | wrapCode }} |
{{- end }}
2023-03-23 17:42:20 -05:00
{{- with $opt.Default }}
| Default | {{- . | wrapCode }} |
2023-02-22 19:53:21 -06:00
{{ "" }}
{{ end }}
{{ "" }}
2023-03-23 17:42:20 -05:00
{{ $opt.Description | newLinesToBr }}
2023-02-22 19:53:21 -06:00
{{- end}}