tui-development

Guide for developing the OpenShell TUI — a ratatui-based terminal UI for the OpenShell platform. Covers architecture, navigation, data fetching, theming, UX conventions, and development workflow. Trigger keywords - term, TUI, terminal UI, ratatui, openshell-tui, tui development, tui feature, tui bug.

Quality

96%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Low

Low-risk findings worth noting

Quality

Content

92%Weight 40%Scale 1-3

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The content is a dense, highly actionable reference with executable code and clearly sequenced workflows including validation checkpoints for destructive operations. Its main weakness is progressive disclosure: it is monolithic with no bundle files or external references to offload the detailed reference tables.

Suggestions

Extract the full Theme struct field table and proto field reference into dedicated reference files (e.g. theme.md, proto.md) referenced one level deep from the body, leaving the SKILL.md as a concise overview.

Consider moving the detailed key-binding and screen-specific hint tables into a reference file, keeping only the essential vim-style navigation summary inline.

Add a short top-of-file 'Quick start' section linking to the detailed sections so agents can orient before diving into the full reference.

Dimension	Reasoning	Score
Conciseness	The body is information-dense and assumes Claude's competence — no basic concept tutorials or library explainers — with every section (proto gotchas, theme tables, key bindings) earning its place for an agent working on this TUI.	3 / 3
Actionability	Provides fully executable commands (cargo build -p openshell-tui, mise run term, kubectl delete pod, helm upgrade) and copy-paste Rust snippets with exact field names and file paths.	3 / 3
Workflow Clarity	Multi-step processes (adding a screen, a gRPC call, an Event variant, log-streaming and gateway-switch lifecycles) are explicitly numbered, with a confirm dialog gating destructive deletes and error feedback on gateway switch failure.	3 / 3
Progressive Disclosure	No bundle files exist and the entire reference is a single ~500-line document; detailed material that could live in separate files (the 16-field theme table, proto field reference) is inline rather than split with one-level-deep references, though the nine numbered sections keep it well organized.	2 / 3
	Total	11 / 12 Passed

Description

100%Weight 40%Scale 1-3

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is specific, third-person, and supplies explicit trigger keywords, cleanly answering both what the skill does and when to use it. It is concise without padding and occupies a distinct niche.

Dimension	Reasoning	Score
Specificity	Enumerates multiple concrete coverage areas — "architecture, navigation, data fetching, theming, UX conventions, and development workflow" — matching the anchor for listing multiple specific capabilities rather than vague language.	3 / 3
Completeness	Clearly states what it does (a development guide covering six named areas) and provides explicit trigger guidance via the Trigger keywords clause, satisfying both the what and the when.	3 / 3
Trigger Term Quality	Provides an explicit trigger-keyword list ("term, TUI, terminal UI, ratatui, openshell-tui, tui development, tui feature, tui bug") giving good coverage of natural terms a user would say.	3 / 3
Distinctiveness Conflict Risk	"OpenShell TUI" with ratatui/openshell-tui triggers carves a clear niche unlikely to conflict with other skills.	3 / 3
	Total	12 / 12 Passed

Validation

93%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

Criteria	Description	Result
skill_md_line_count	SKILL.md is long (501 lines); consider splitting into references/ and linking	Warning

	Total	15 / 16 Passed

Repository: NVIDIA/OpenShell
Path: .agents/skills/tui-development/SKILL.md
Commit: deced87

Reviewed: 6 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.