TermStack

TermStack is a powerful, config-driven Terminal User Interface (TUI) framework designed for creating rich, navigable dashboards through simple YAML configuration files. This innovative tool is inspired by the renowned k9s and extends its capabilities beyond Kubernetes to a variety of applications, including REST APIs, CLI tools, and more.

Key Features

• Config-Driven: Build your TUIs easily by defining pages, data sources, views, and actions in YAML, eliminating the need for complex UI coding.
• Multiple Data Adapters: Seamlessly connect to a range of data sources including HTTP APIs, CLI commands, scripts, and streaming data.
• Rich Views: Enhance your terminal experience with table, text, logs, and YAML views.
• Template Engine: Use Tera templates for dynamic content generation, improving flexibility in your configurations.
• Navigation and Actions: Drill down into data efficiently with conditional routing, allowing for various actions based on user input.
• Asynchronous Operations: Fetch data without blocking the UI, ensuring a smooth and responsive user experience.

AI-Powered YAML Generation

TermStack offers an AI integration feature—Claude Code—that automates YAML configuration. Users can simply describe their desired output in plain English, and Claude will handle the syntax and structure, saving time and reducing errors. For instance, by typing:

/termstack "create a GitHub repository browser with issues and PRs"

Claude generates the complete YAML configuration and saves it for use, streamlining the development process.

Examples of Usage

1. Browse Dog Breeds:

   termstack examples/dog-api.yaml
   

   This example leverages the DogAPI to provide a seamless browsing experience for dog breeds and related facts.
2. Kubernetes Dashboard:

   termstack examples/kubernetes-cli.yaml
   

   A k9s-style interface enables users to navigate through Kubernetes resources effectively.

Configuration Overview

TermStack configuration is straightforward, allowing users to specify the application's name, themes, and data sources in a clear YAML structure. For instance:

version: v1
app:
  name: "My First TUI"
  description: "A simple terminal UI"
  theme: "default"

start: main

pages:
  main:
    title: "Welcome!"
    data:
      adapter: cli
      command: "echo"
      args: ['Hello, TermStack!']
    view:
      type: table
      columns:
        - path: "$.message"
          display: "Message"
          width: 40

Learn More

For comprehensive documentation, guides, and real-world examples, refer to the Complete Documentation.

Experience the ease of creating terminal UIs with TermStack, a solution that blends creativity and technology, highlighting the potential of no-code development in modern software practices.