Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/opencli.ocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,44 @@ The framework of the CLI boilerplate to generate
- `env:$OCLI_CLI_FRAMEWORK`
- `file:$.cli.framework`

#### Examples

```sh
# generate Cobra (Go) CLI

$ ocli gen cli \
--framework cobra \
--out ./internal \
./my-cli.ocs.yaml
# → Reading spec: ./my-cli.ocs.yaml
# → Generating CLI code: framework=cobra, output=./internal
# ✓ CLI Code written to: ./internal

```
```sh
# generate urfave/cli (Go) CLI

$ ocli gen cli \
--framework urfavecli \
--out ./internal \
./my-cli.ocs.yaml
# → Reading spec: ./my-cli.ocs.yaml
# → Generating CLI code: framework=urfavecli, output=./internal
# ✓ CLI Code written to: ./internal

```
```sh
# generate Yargs (Node.JS) CLI

$ ocli gen cli \
--framework yargs \
--out ./src \
./my-cli.ocs.yaml
# → Reading spec: ./my-cli.ocs.yaml
# → Generating CLI code: framework=yargs, output=./src
# ✓ CLI Code written to: ./src
```

---

<div style="text-align:center;font-size:12px;">generated by <a href="https://opencli.dev">OpenCLI</a></div>
Expand Down
244 changes: 139 additions & 105 deletions gen/templates/html/command-section.tmpl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{{define "commandSection"}}
{{- if not .Hidden}}
{{- if or (ne .Kind "group") .Summary .Description .VisibleArgs .VisibleFlags .ExitCodes}}
{{- if or (ne .Kind "group") .Summary .Description .VisibleArgs .VisibleFlags .ExitCodes .Examples}}
<section class="ocli-section" id="{{slugify .CommandLine}}">
<div class="ocli-section__sticky">
<div class="ocli-section__cmd-anchor"><button class="ocli-deeplink-btn" type="button" data-href="#{{slugify .CommandLine}}" aria-label="Copy link"><svg class="ocli-deeplink-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"/><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"/></svg></button><code class="ocli-section__cmd">$ {{.CommandLine}}{{range .CommandModifiers}} {{.}}{{end}}{{range .ArgsModifiers}} {{.}}{{end}}{{range .FlagsModifiers}} {{.}}{{end}}</code></div>
Expand All @@ -10,123 +10,157 @@
</div>
{{- end}}
</div>
{{- if .Examples}}
<div class="ocli-section__body ocli-section__body--two-col">
<div class="ocli-section__col-left">
{{template "commandBody" .}}
</div>
<div class="ocli-section__col-right">
{{template "commandExamples" .}}
</div>
</div>
{{- else}}
<div class="ocli-section__body">
{{- if .Summary}}
<p class="ocli-summary">{{.Summary}}</p>
{{- end}}
{{- if .Description}}
<div class="ocli-md">{{mdToHTML .Description}}</div>
{{- end}}
{{template "commandBody" .}}
</div>
{{- end}}
</section>
{{- end}}
{{- range .Commands}}{{template "commandSection" .}}{{end}}
{{- end}}
{{end}}

{{- if .VisibleArgs}}
<div class="ocli-params">
<div class="ocli-params__heading">Arguments</div>
{{- range .Args}}{{if not .Hidden}}
<div class="ocli-param" id="{{slugify $.CommandLine}}-arg-{{slugify .Name}}">
<div class="ocli-param__header">
<div class="ocli-param__anchor"><button class="ocli-deeplink-btn" type="button" data-href="#{{slugify $.CommandLine}}-arg-{{slugify .Name}}" aria-label="Copy link"><svg class="ocli-deeplink-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"/><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"/></svg></button><code class="ocli-param__name">&lt;{{.Name}}{{if .Variadic}}...{{end}}&gt;</code></div>
</div>
<div class="ocli-badges">
<span class="ocli-badge ocli-badge--default">{{.Type}}</span>
{{- if .Choices}}<span class="ocli-badge ocli-badge--default">enum</span>{{end}}
{{- if .Required}}<span class="ocli-badge ocli-badge--required">required</span>{{end}}
{{- if .Variadic}}<span class="ocli-badge ocli-badge--default">variadic</span>{{end}}
{{- if .Default}}<span class="ocli-badge ocli-badge--default">default: {{.Default}}</span>{{end}}
</div>
{{- if .Summary}}<p class="ocli-param__summary">{{.Summary}}</p>{{end}}
{{- if .Description}}<div class="ocli-param__desc ocli-md">{{mdToHTML .Description}}</div>{{end}}
{{- if .Choices}}
<div class="ocli-choices">
<div class="ocli-choices__label">Accepted values</div>
<ul class="ocli-choices__list">
{{- range .Choices}}
<li class="ocli-choices__item">
<code>{{.Value}}</code>
{{- if .Description}}<span class="ocli-choices__item-desc">{{.Description}}</span>{{end}}
</li>
{{- end}}
</ul>
</div>
{{define "commandBody"}}
{{- if .Summary}}
<p class="ocli-summary">{{.Summary}}</p>
{{- end}}
{{- if .Description}}
<div class="ocli-md">{{mdToHTML .Description}}</div>
{{- end}}

{{- if .VisibleArgs}}
<div class="ocli-params">
<div class="ocli-params__heading">Arguments</div>
{{- range .Args}}{{if not .Hidden}}
<div class="ocli-param" id="{{slugify $.CommandLine}}-arg-{{slugify .Name}}">
<div class="ocli-param__header">
<div class="ocli-param__anchor"><button class="ocli-deeplink-btn" type="button" data-href="#{{slugify $.CommandLine}}-arg-{{slugify .Name}}" aria-label="Copy link"><svg class="ocli-deeplink-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"/><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"/></svg></button><code class="ocli-param__name">&lt;{{.Name}}{{if .Variadic}}...{{end}}&gt;</code></div>
</div>
<div class="ocli-badges">
<span class="ocli-badge ocli-badge--default">{{.Type}}</span>
{{- if .Choices}}<span class="ocli-badge ocli-badge--default">enum</span>{{end}}
{{- if .Required}}<span class="ocli-badge ocli-badge--required">required</span>{{end}}
{{- if .Variadic}}<span class="ocli-badge ocli-badge--default">variadic</span>{{end}}
{{- if .Default}}<span class="ocli-badge ocli-badge--default">default: {{.Default}}</span>{{end}}
</div>
{{- if .Summary}}<p class="ocli-param__summary">{{mdToHTML .Summary}}</p>{{end}}
{{- if .Description}}<div class="ocli-param__desc ocli-md">{{mdToHTML .Description}}</div>{{end}}
{{- if .Choices}}
<div class="ocli-choices">
<div class="ocli-choices__label">Accepted values</div>
<ul class="ocli-choices__list">
{{- range .Choices}}
<li class="ocli-choices__item">
<code>{{.Value}}</code>
{{- if .Description}}<span class="ocli-choices__item-desc">{{mdToHTML .Description}}</span>{{end}}
</li>
{{- end}}
</div>
{{- end}}{{end}}
</ul>
</div>
{{- end}}
</div>
{{- end}}{{end}}
</div>
{{- end}}

{{- if .VisibleFlags}}
<div class="ocli-params">
<div class="ocli-params__heading">Flags</div>
{{- range .Flags}}{{if not .Hidden}}
<div class="ocli-param" id="{{slugify $.CommandLine}}-flag-{{slugify .Name}}">
<div class="ocli-param__header">
<div class="ocli-param__anchor"><button class="ocli-deeplink-btn" type="button" data-href="#{{slugify $.CommandLine}}-flag-{{slugify .Name}}" aria-label="Copy link"><svg class="ocli-deeplink-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"/><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"/></svg></button><code class="ocli-param__name">--{{.Name}}</code>
{{- if .Aliases}}
{{- range .Aliases}}<code class="ocli-param__name">-{{.}}</code>{{end}}
{{- end}}</div>
</div>
<div class="ocli-badges">
<span class="ocli-badge ocli-badge--default">{{.Type}}</span>
{{- if .Choices}}<span class="ocli-badge ocli-badge--default">enum</span>{{end}}
{{- if .Required}}<span class="ocli-badge ocli-badge--required">required</span>{{end}}
{{- if .Variadic}}<span class="ocli-badge ocli-badge--default">variadic</span>{{end}}
{{- if .Default}}<span class="ocli-badge ocli-badge--default">default: {{.Default}}</span>{{end}}
</div>
{{- if .Summary}}<p class="ocli-param__summary">{{.Summary}}</p>{{end}}
{{- if .Description}}<div class="ocli-param__desc ocli-md">{{mdToHTML .Description}}</div>{{end}}
{{- if .Choices}}
<div class="ocli-choices">
<div class="ocli-choices__label">Accepted values</div>
<ul class="ocli-choices__list">
{{- range .Choices}}
<li class="ocli-choices__item">
<code>{{.Value}}</code>
{{- if .Description}}<span class="ocli-choices__item-desc">{{.Description}}</span>{{end}}
</li>
{{- end}}
</ul>
</div>
{{- end}}
{{- if .AltSources}}
<div class="ocli-alt-sources">
<div class="ocli-alt-sources__label">Alternative sources</div>
<ul class="ocli-alt-sources__list">
{{- range .AltSources}}
<li class="ocli-alt-sources__item">
{{- if eq .Type "$ENV"}}
<code>env: ${{.Property}}</code>
{{- else}}
<code>file: {{.Property}}</code>
{{- end}}
</li>
{{- end}}
</ul>
</div>
{{- if .VisibleFlags}}
<div class="ocli-params">
<div class="ocli-params__heading">Flags</div>
{{- range .Flags}}{{if not .Hidden}}
<div class="ocli-param" id="{{slugify $.CommandLine}}-flag-{{slugify .Name}}">
<div class="ocli-param__header">
<div class="ocli-param__anchor"><button class="ocli-deeplink-btn" type="button" data-href="#{{slugify $.CommandLine}}-flag-{{slugify .Name}}" aria-label="Copy link"><svg class="ocli-deeplink-icon" xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"/><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"/></svg></button><code class="ocli-param__name">--{{.Name}}</code>
{{- if .Aliases}}
{{- range .Aliases}}<code class="ocli-param__name">-{{.}}</code>{{end}}
{{- end}}</div>
</div>
<div class="ocli-badges">
<span class="ocli-badge ocli-badge--default">{{.Type}}</span>
{{- if .Choices}}<span class="ocli-badge ocli-badge--default">enum</span>{{end}}
{{- if .Required}}<span class="ocli-badge ocli-badge--required">required</span>{{end}}
{{- if .Variadic}}<span class="ocli-badge ocli-badge--default">variadic</span>{{end}}
{{- if .Default}}<span class="ocli-badge ocli-badge--default">default: {{.Default}}</span>{{end}}
</div>
{{- if .Summary}}<p class="ocli-param__summary">{{mdToHTML .Summary}}</p>{{end}}
{{- if .Description}}<div class="ocli-param__desc ocli-md">{{mdToHTML .Description}}</div>{{end}}
{{- if .Choices}}
<div class="ocli-choices">
<div class="ocli-choices__label">Accepted values</div>
<ul class="ocli-choices__list">
{{- range .Choices}}
<li class="ocli-choices__item">
<code>{{.Value}}</code>
{{- if .Description}}<span class="ocli-choices__item-desc">{{mdToHTML .Description}}</span>{{end}}
</li>
{{- end}}
</div>
{{- end}}{{end}}
</ul>
</div>
{{- end}}

{{- if .ExitCodes}}
<div class="ocli-params">
<div class="ocli-params__heading">Exit Codes</div>
{{- range .ExitCodes}}
<div class="ocli-exit-code">
<span class="ocli-exit-code__code">{{.Code}}</span>
<div class="ocli-exit-code__details">
<div class="ocli-exit-code__status">{{.Status}}</div>
<div class="ocli-exit-code__summary">{{.Summary}}</div>
{{- if .Description}}
<div class="ocli-exit-code__desc">{{.Description}}</div>
{{- if .AltSources}}
<div class="ocli-alt-sources">
<div class="ocli-alt-sources__label">Alternative sources</div>
<ul class="ocli-alt-sources__list">
{{- range .AltSources}}
<li class="ocli-alt-sources__item">
{{- if eq .Type "$ENV"}}
<code>env: ${{.Property}}</code>
{{- else}}
<code>file: {{.Property}}</code>
{{- end}}
</div>
</div>
{{- end}}
</li>
{{- end}}
</ul>
</div>
{{- end}}
</div>
</section>
{{- end}}{{end}}
</div>
{{- end}}
{{- range .Commands}}{{template "commandSection" .}}{{end}}

{{- if .ExitCodes}}
<div class="ocli-params">
<div class="ocli-params__heading">Exit Codes</div>
{{- range .ExitCodes}}
<div class="ocli-exit-code">
<span class="ocli-exit-code__code">{{.Code}}</span>
<div class="ocli-exit-code__details">
<div class="ocli-exit-code__status">{{.Status}}</div>
<div class="ocli-exit-code__summary">{{mdToHTML .Summary}}</div>
{{- if .Description}}
<div class="ocli-exit-code__desc">{{mdToHTML .Description}}</div>
{{- end}}
</div>
</div>
{{- end}}
</div>
{{- end}}
{{end}}

{{define "commandExamples"}}
<div class="ocli-examples">
<div class="ocli-examples__heading">Examples</div>
{{- range .Examples}}
<div class="ocli-example">
{{- if .Title}}
<div class="ocli-example__title">{{.Title}}</div>
{{- end}}
<div class="ocli-code-block ocli-code-block--terminal">
<div class="ocli-code-block__header">
<span class="ocli-code-block__label">Terminal</span>
</div>
<pre class="ocli-code-block__body">{{.Content}}</pre>
</div>
</div>
{{- end}}
</div>
{{end}}
40 changes: 21 additions & 19 deletions gen/templates/html/sections.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -98,25 +98,27 @@
<span class="ocli-section__sticky-title">Configuration</span>
</div>
<div class="ocli-section__body">
<table class="ocli-table">
<thead>
<tr>
<th>Format</th>
<th>Path</th>
</tr>
</thead>
<tbody>
{{- if .Doc.Global.Config.JSON}}
<tr><td>JSON</td><td><code>{{.Doc.Global.Config.JSON}}</code></td></tr>
{{- end}}
{{- if .Doc.Global.Config.TOML}}
<tr><td>TOML</td><td><code>{{.Doc.Global.Config.TOML}}</code></td></tr>
{{- end}}
{{- if .Doc.Global.Config.YAML}}
<tr><td>YAML</td><td><code>{{.Doc.Global.Config.YAML}}</code></td></tr>
{{- end}}
</tbody>
</table>
<div class="ocli-table-container">
<table class="ocli-table">
<thead>
<tr>
<th>Format</th>
<th>Path</th>
</tr>
</thead>
<tbody>
{{- if .Doc.Global.Config.JSON}}
<tr><td>JSON</td><td><code>{{.Doc.Global.Config.JSON}}</code></td></tr>
{{- end}}
{{- if .Doc.Global.Config.TOML}}
<tr><td>TOML</td><td><code>{{.Doc.Global.Config.TOML}}</code></td></tr>
{{- end}}
{{- if .Doc.Global.Config.YAML}}
<tr><td>YAML</td><td><code>{{.Doc.Global.Config.YAML}}</code></td></tr>
{{- end}}
</tbody>
</table>
</div>
</div>
</section>
{{end}}
Expand Down
Loading
Loading