Skip to content

Commit bb1a865

Browse files
xoofxxoofx
committed
Add links to XenoAtom.Terminal.UI
1 parent 47f0eb1 commit bb1a865

3 files changed

Lines changed: 43 additions & 82 deletions

File tree

‎site/docs/help-output.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ app.AddRemainder("Extra arguments");
113113

114114
## Inline Visual Nodes
115115

116-
When using `XenoAtom.CommandLine.Terminal`, you can add [Terminal.UI `Visual` controls](https://xenoatom.github.io/terminal/docs/controls/) directly in command initializers.
116+
When using `XenoAtom.CommandLine.Terminal`, you can add [XenoAtom.Terminal.UI](https://xenoatom.github.io/terminal) `Visual` controls directly in command initializers.
117117

118118
```csharp
119119
using XenoAtom.CommandLine;
@@ -291,7 +291,7 @@ var app = new CommandApp("myexe", config: new CommandConfig
291291

292292
### TerminalVisualCommandOutput
293293

294-
Renders help and errors as Terminal.UI visuals with borders, tables, and structured layout:
294+
Renders help and errors as [XenoAtom.Terminal.UI](https://xenoatom.github.io/terminal) visuals with borders, tables, and structured layout:
295295

296296
```csharp
297297
using XenoAtom.CommandLine;
@@ -336,7 +336,7 @@ var app = new CommandApp("myexe", config: new CommandConfig
336336

337337
### Standalone Visual Help
338338

339-
Generate a help visual for embedding in fullscreen Terminal.UI applications:
339+
Generate a help visual for embedding in fullscreen [XenoAtom.Terminal.UI](https://xenoatom.github.io/terminal) applications:
340340

341341
```csharp
342342
var helpVisual = app.ToHelpVisual(new TerminalVisualOutputOptions

‎site/docs/readme.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Welcome to the XenoAtom.CommandLine documentation. This guide covers everything
1010

1111
**XenoAtom.CommandLine** is a lightweight, powerful and NativeAOT-friendly command-line parser for .NET. It uses a composition-first API — you declare commands, options, and arguments with collection initializers, and the library handles parsing, help generation, and error reporting.
1212

13-
With the optional `XenoAtom.CommandLine.Terminal` package, you can also embed Terminal.UI visuals directly in command initializers for richer help output.
13+
With the optional `XenoAtom.CommandLine.Terminal` package, you can also embed [XenoAtom.Terminal.UI](https://xenoatom.github.io/terminal) visuals directly in command initializers for richer help output.
1414

1515
```csharp
1616
var app = new CommandApp("myexe")

‎site/readme.md‎

Lines changed: 39 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -18,126 +18,87 @@ og_type: website
1818
<a href="{{site.basepath}}/docs/" class="btn btn-outline-light btn-lg"><i class="bi bi-book"></i> Browse docs</a>
1919
<a href="https://github.com/XenoAtom/XenoAtom.CommandLine/" class="btn btn-info btn-lg"><i class="bi bi-github"></i> GitHub</a>
2020
</div>
21-
<div class="mt-4 text-start mx-auto" style="max-width: 56rem;">
22-
<pre class="language-shell-session"><code>dotnet add package XenoAtom.CommandLine</code></pre>
23-
<pre class="language-shell-session"><code>dotnet add package XenoAtom.CommandLine.Terminal # For terminal UI and visual output</code></pre>
21+
<div class="row row-cols-1 row-cols-lg-2 gx-3 gy-3 mt-4 text-start mx-auto" style="max-width: 66rem;">
22+
<div class="col">
23+
<div class="card h-100">
24+
<div class="card-header h5"><i class="bi bi-box-seam xenoatom-feature-icon xenoatom-icon--input"></i>Core package</div>
25+
<div class="card-body">
26+
<p class="mb-2">Install <code>XenoAtom.CommandLine</code> for the parser, help system, validation, and completions.</p>
27+
<pre class="language-shell-session mb-0"><code>dotnet add package XenoAtom.CommandLine</code></pre>
28+
</div>
29+
</div>
30+
</div>
31+
<div class="col">
32+
<div class="card h-100">
33+
<div class="card-header h5"><i class="bi bi-display xenoatom-feature-icon xenoatom-icon--controls"></i>Terminal visuals (optional)</div>
34+
<div class="card-body">
35+
<p class="mb-2">Add <code>XenoAtom.CommandLine.Terminal</code> for markup and rich visual output powered by <a href="https://xenoatom.github.io/terminal">XenoAtom.Terminal.UI</a>.</p>
36+
<pre class="language-shell-session mb-0"><code>dotnet add package XenoAtom.CommandLine.Terminal</code></pre>
37+
</div>
38+
</div>
39+
</div>
40+
</div>
41+
<div class="mt-4">
42+
<p class="mb-2 text-white-50">Animation preview (default help, markup, visual output, and diagnostics):</p>
43+
<img class="terminal img-fluid" src="{{site.basepath}}/img/xenoatom-commandline-show.gif" alt="XenoAtom.CommandLine output modes animation">
2444
</div>
25-
<img class="terminal img-fluid" src="{{site.basepath}}/img/xenoatom-commandline-show.gif"></img>
2645
</div>
2746
</section>
2847

2948
<section class="container my-5">
3049
<h2 class="display-6 mb-4"><i class="bi bi-stars xenoatom-feature-icon xenoatom-icon--themes"></i>Features</h2>
31-
<div class="row row-cols-1 row-cols-lg-2 row-cols-xxl-3 gx-4 gy-4">
50+
<div class="row row-cols-1 row-cols-lg-2 gx-4 gy-4">
3251
<div class="col">
3352
<div class="card h-100">
34-
<div class="card-header h4"><i class="bi bi-diagram-3 xenoatom-feature-icon xenoatom-icon--layout"></i> Commands &amp; Composition</div>
53+
<div class="card-header h4"><i class="bi bi-diagram-3 xenoatom-feature-icon xenoatom-icon--layout"></i> Commands &amp; Arguments</div>
3554
<div class="card-body">
36-
<ul>
37-
<li><strong>Structure:</strong> nested commands and command trees</li>
38-
<li><strong>Authoring:</strong> collection initializer and fluent helpers</li>
39-
<li><strong>Sections:</strong> usage/text nodes and explicit group headers</li>
40-
<li><strong>Conditionality:</strong> runtime-activated groups</li>
41-
</ul>
42-
<p><a href="{{site.basepath}}/docs/commands/">Commands</a></p>
55+
<p class="card-text mb-2">Compose nested command trees and strict positional arguments with cardinality support.</p>
56+
<p class="mb-0"><a href="{{site.basepath}}/docs/commands/">Commands docs</a> · <a href="{{site.basepath}}/docs/arguments/">Arguments docs</a></p>
4357
</div>
4458
</div>
4559
</div>
4660
<div class="col">
4761
<div class="card h-100">
48-
<div class="card-header h4"><i class="bi bi-terminal xenoatom-feature-icon xenoatom-icon--input"></i> Parsing &amp; Syntax</div>
62+
<div class="card-header h4"><i class="bi bi-terminal xenoatom-feature-icon xenoatom-icon--input"></i> Option Parsing</div>
4963
<div class="card-body">
50-
<ul>
51-
<li><strong>Prefixes:</strong> <code>-</code>, <code>--</code>, <code>/</code> with aliases</li>
52-
<li><strong>Values:</strong> required, optional, and key/value option forms</li>
53-
<li><strong>Short bundles:</strong> POSIX-style <code>-abc</code> expansion</li>
54-
<li><strong>Positionals:</strong> <code>&lt;arg&gt;</code>, <code>?/*/+</code>, and <code>&lt;&gt;</code></li>
55-
</ul>
56-
<p><a href="{{site.basepath}}/docs/options/">Options</a> · <a href="{{site.basepath}}/docs/arguments/">Arguments</a></p>
64+
<p class="card-text mb-2">Support <code>-</code>/<code>--</code>/<code>/</code>, aliases, short bundles, key/value forms, and typed parsing.</p>
65+
<p class="mb-0"><a href="{{site.basepath}}/docs/options/">Options docs</a></p>
5766
</div>
5867
</div>
5968
</div>
6069
<div class="col">
6170
<div class="card h-100">
6271
<div class="card-header h4"><i class="bi bi-shield-check xenoatom-feature-icon xenoatom-icon--actions"></i> Validation &amp; Constraints</div>
6372
<div class="card-body">
64-
<ul>
65-
<li><strong>Built-ins:</strong> range, non-empty, one-of, and path helpers</li>
66-
<li><strong>Custom rules:</strong> delegate validation on options/arguments</li>
67-
<li><strong>Exclusivity:</strong> mutually exclusive option sets</li>
68-
<li><strong>Dependencies:</strong> requires constraints between options</li>
69-
</ul>
70-
<p><a href="{{site.basepath}}/docs/validation/">Validation &amp; Constraints</a></p>
73+
<p class="card-text mb-2">Use built-in validators, custom delegates, mutually-exclusive options, and requires relationships.</p>
74+
<p class="mb-0"><a href="{{site.basepath}}/docs/validation/">Validation docs</a></p>
7175
</div>
7276
</div>
7377
</div>
7478
<div class="col">
7579
<div class="card h-100">
7680
<div class="card-header h4"><i class="bi bi-chat-square-text xenoatom-feature-icon xenoatom-icon--debug"></i> Help &amp; Diagnostics</div>
7781
<div class="card-body">
78-
<ul>
79-
<li><strong>Help generation:</strong> usage and sections from declarations</li>
80-
<li><strong>Suggestions:</strong> unknown command/option hints</li>
81-
<li><strong>Context:</strong> diagnostics carry command/option/argument info</li>
82-
<li><strong>Readability:</strong> clear errors with usage guidance</li>
83-
</ul>
84-
<p><a href="{{site.basepath}}/docs/help-output/">Help &amp; Output</a></p>
82+
<p class="card-text mb-2">Generate help automatically and provide context-aware errors with useful suggestions.</p>
83+
<p class="mb-0"><a href="{{site.basepath}}/docs/help-output/">Help &amp; output docs</a></p>
8584
</div>
8685
</div>
8786
</div>
8887
<div class="col">
8988
<div class="card h-100">
9089
<div class="card-header h4"><i class="bi bi-plug xenoatom-feature-icon xenoatom-icon--binding"></i> Extensible Output</div>
9190
<div class="card-body">
92-
<ul>
93-
<li><strong>Pluggable:</strong> replace <code>ICommandOutput</code> end-to-end</li>
94-
<li><strong>Modes:</strong> default, markup, and visual help/error rendering</li>
95-
<li><strong>Factory-based:</strong> context-aware output construction</li>
96-
<li><strong>Custom formats:</strong> add JSON or app-specific renderers</li>
97-
</ul>
98-
<p><a href="{{site.basepath}}/docs/help-output/">Custom Output Rendering</a></p>
99-
</div>
100-
</div>
101-
</div>
102-
<div class="col">
103-
<div class="card h-100">
104-
<div class="card-header h4"><i class="bi bi-display xenoatom-feature-icon xenoatom-icon--controls"></i> Terminal Integration</div>
105-
<div class="card-body">
106-
<ul>
107-
<li><strong>Optional package:</strong> <code>XenoAtom.CommandLine.Terminal</code></li>
108-
<li><strong>Markup output:</strong> colored help and diagnostics</li>
109-
<li><strong>Visual output:</strong> rich help trees and grouped blocks</li>
110-
<li><strong>Composable visuals:</strong> inline visual nodes in command trees</li>
111-
</ul>
112-
<p><a href="{{site.basepath}}/docs/advanced/">Advanced Topics</a></p>
113-
</div>
114-
</div>
115-
</div>
116-
<div class="col">
117-
<div class="card h-100">
118-
<div class="card-header h4"><i class="bi bi-tools xenoatom-feature-icon xenoatom-icon--data"></i> Tooling &amp; Workflow</div>
119-
<div class="card-body">
120-
<ul>
121-
<li><strong>Parse API:</strong> inspect parse results without execution</li>
122-
<li><strong>Response files:</strong> <code>@file</code> expansion with comments/quotes</li>
123-
<li><strong>Completions:</strong> bash/zsh/fish/PowerShell generation</li>
124-
<li><strong>Environment:</strong> option fallback from environment variables</li>
125-
</ul>
126-
<p><a href="{{site.basepath}}/docs/advanced/">Advanced Topics</a></p>
91+
<p class="card-text mb-2">Swap output pipelines through <code>ICommandOutput</code> and choose default, markup, or custom formats.</p>
92+
<p class="mb-0"><a href="{{site.basepath}}/docs/help-output/">Output customization docs</a></p>
12793
</div>
12894
</div>
12995
</div>
13096
<div class="col">
13197
<div class="card h-100">
132-
<div class="card-header h4"><i class="bi bi-lightning-charge xenoatom-feature-icon xenoatom-icon--themes"></i> Runtime &amp; Platform</div>
98+
<div class="card-header h4"><i class="bi bi-display xenoatom-feature-icon xenoatom-icon--controls"></i> Terminal &amp; Advanced</div>
13399
<div class="card-body">
134-
<ul>
135-
<li><strong>NativeAOT:</strong> trimming-friendly architecture</li>
136-
<li><strong>Performance:</strong> low-allocation, span-based parser paths</li>
137-
<li><strong>Portability:</strong> cross-platform CLI semantics</li>
138-
<li><strong>Minimalism:</strong> lightweight core package and focused API</li>
139-
</ul>
140-
<p><a href="{{site.basepath}}/docs/migration-2.0/">Migration 2.0</a></p>
100+
<p class="card-text mb-2">Add terminal markup/visual output, response files, completions, Parse API, and NativeAOT-friendly runtime behavior.</p>
101+
<p class="mb-0"><a href="{{site.basepath}}/docs/help-output/">Help &amp; output docs</a> · <a href="{{site.basepath}}/docs/advanced/">Advanced docs</a> · <a href="{{site.basepath}}/docs/migration-2.0/">Migration 2.0</a></p>
141102
</div>
142103
</div>
143104
</div>

0 commit comments

Comments
 (0)