Skip to main content

Terminal UI package for ssot-registry workflows.

Project description

🔷 ssot-tui

Textual terminal UI for browsing SSOT registries.

PyPI version Supported Python versions Downloads Repository hits

ssot-tui is a Textual-based terminal UI for browsing SSOT registries.

It is focused on read-oriented exploration and safe workflow bridges rather than full CRUD parity with the CLI.

What this package owns

  • The ssot-tui console entry point
  • The Textual app shell and browser screen
  • TUI widgets for section navigation, entity tables, and detail panes

When to use this package

Use ssot-tui when you want:

  • an interactive terminal browser for SSOT registry content
  • a navigable view across entity sections with filters, recent repos, and keyboard-first navigation
  • structured entity detail views with a raw JSON fallback
  • safe workflow bridges such as validation, CLI read previews, and opening repo resources
  • a Textual UI on top of the ssot-core runtime

Use another package when you want:

Install

python -m pip install ssot-tui

For local development from this repository:

python -m pip install -e pkgs/ssot-tui

This package depends on ssot-core, ssot-contracts, and textual.

Start the TUI

ssot-tui

The current entry point launches SsotTuiApp, which mounts a browser-oriented screen when the application starts.

Interaction model

The browser now supports:

  • repo auto-discovery from the current working directory
  • persisted recent repos and last-viewed session state
  • inline filtering with /
  • a command palette with Ctrl+P
  • a help overlay with ?
  • pane navigation with Tab, Shift+Tab, h, j, k, and l
  • reload and validation via r and v
  • structured detail rendering with t to toggle raw JSON
  • table view cycling with m

The detail pane can traverse linked entity ids, preview file-backed resources, and render safe CLI read previews for the current section or entity.

Screenshots

Regenerate these assets with python scripts/generate_tui_screenshots.py.

Captured against examples/minimal-repo in this workspace:

SSOT TUI browser

SSOT TUI ADR browser

SSOT TUI spec browser

SSOT TUI validation status

Current scope

The current implementation is browser-first and read-first:

  • workspace loading, recent repo switching, and validation summaries
  • section-based navigation with per-section counts and failure rollups
  • tabular browsing with filter and mode switching
  • structured and raw detail inspection for the selected item
  • safe bridge actions for opening files, revealing paths, and previewing read-only CLI output

The package still does not implement full CRUD or guided operational workflows with CLI-level parity.

Main UI concepts

The current source tree exposes these UI building blocks:

  • BrowserScreen: the primary browser screen
  • SectionNavigation: a section chooser with counts and validation indicators
  • EntityTable: a table view for entities in the active section
  • EntityDetailPane: a structured detail view with related-resource traversal
  • CommandPaletteScreen: an action launcher backed by the shared action registry
  • HelpScreen: a keyboard and action reference overlay
  • StatusCenter: a persistent status and toast history panel

At the application level, SsotTuiApp provides a header, footer, and browser screen composition.

Package relationships

  • Package type: terminal UI package
  • Depends on: ssot-core, ssot-contracts, textual
  • Consumed by: users who want interactive browsing on top of the core SSOT runtime

If you need complete operational coverage today, use ssot-cli. If you want an interactive terminal browser for current registry content, this package is the right entry point.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssot_tui-0.1.4.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssot_tui-0.1.4-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file ssot_tui-0.1.4.tar.gz.

File metadata

  • Download URL: ssot_tui-0.1.4.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ssot_tui-0.1.4.tar.gz
Algorithm Hash digest
SHA256 fc44da0dbf29d6f90b1503e376f6e63973b653ed2d2ad4988a3f26eed4b6d797
MD5 fa15eaee67b3b1e6e290c17b5f517e68
BLAKE2b-256 33f934ab94dd5dc9723e5b7df02233188b60af2417e661c201c4142239d135ae

See more details on using hashes here.

File details

Details for the file ssot_tui-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ssot_tui-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ssot_tui-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d9d99fcef2b82534154d551925b0ad154fdb4f03504b16c2c872a059fa71b5fe
MD5 ac657033eb3481942841cbd5b011ac85
BLAKE2b-256 3a078770613baab770c81df300c7b015d0ede23a5efd33343f626ea2aadde84b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page