Skip to content

Commit 531010a

Browse files
hyperpolymathclaude
andcommitted
docs(readme): add SPDX header and/or standard badges
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent f0ccc11 commit 531010a

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
:toc: preamble
66
:icons: font
77

8+
image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/invariant-path"]
9+
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
10+
image:https://api.thegreenwebfoundation.org/greencheckimage/github.com[Green Web,link="https://www.thegreenwebfoundation.org/green-web-check/?url=github.com"]
11+
812
Invariant Path is a repo-native semantic overlay MVP for tracing how claims
913
move from source evidence/specification to target conclusions.
1014

@@ -32,6 +36,11 @@ cargo run -p invariant-path-cli -- scan --file ./README.md --artifact-uri repo:/
3236
cargo run -p invariant-path-cli -- annotations list --json
3337
----
3438

39+
[source,bash]
40+
----
41+
cargo run -p invariant-path-cli -- tui --file ./README.md --artifact-uri repo://README.md
42+
----
43+
3544
== Launcher Integration
3645

3746
The repository includes an E-Grade compliant launcher and desktop entry:
@@ -47,3 +56,24 @@ Install Start Menu + Desktop shortcuts:
4756
----
4857
./scripts/install-desktop.sh
4958
----
59+
60+
=== TUI Mode
61+
62+
The launcher supports an interactive Terminal User Interface:
63+
64+
[source,bash]
65+
----
66+
# Launch TUI (automatic fallback to scan if terminal not available)
67+
./invariant-path-launcher --tui
68+
69+
# Direct CLI TUI access
70+
cargo run -p invariant-path-cli -- tui --file README.adoc
71+
----
72+
73+
The TUI provides:
74+
* Interactive navigation through claim path suggestions
75+
* Keyboard controls (↑/↓ to navigate, q to quit)
76+
* Visual highlighting of selected items
77+
* Automatic fallback to CLI mode in non-interactive environments
78+
79+
See link:docs/TUI-GUIDE.md[TUI Guide] for comprehensive documentation.

0 commit comments

Comments
 (0)