PitchHut logo
SmartMan CLI
An interactive TUI for Linux man pages with AI enhancements.
Pitch

SmartMan transforms how users interact with Linux man pages through a modern, terminal-native interface. Featuring syntax highlighting, quick navigation, and AI-powered explanations, it simplifies complex commands while providing an engaging user experience.

Description

SmartMan is an innovative command-line tool that redefines the Linux manual (man) experience by providing a modern, terminal-native interface. It transforms traditional, often dense, man pages into an engaging and interactive format complete with syntax highlighting, easy navigation, and AI-powered language explanations. Users will benefit from an aesthetically enhanced terminal interface designed using Textual, featuring the following capabilities:

Features

  • Modern TUI: A responsive terminal interface for an enhanced user experience.
  • Quick-Win Gallery: Access interactive cards featuring common usage examples at the top of each page for efficient reference.
  • Interactive Sidebar: Effortlessly navigate between sections such as NAME, SYNOPSIS, DESCRIPTION, and OPTIONS.
  • Syntax Highlighting: Automatic color coding for flags, parameters, and code snippets, improving readability.
  • AI-Powered Explanations: For complex flags, leverage the --explain command to receive terminology translated into plain English, courtesy of the Groq API.
  • Theming Support: Select from various themes including default, dracula, and monokai to personalize the interface.

Usage Example

To leverage SmartMan, simply prepend your command with smartman:

smartman grep

Additional command options include:

  • --plain: For a quick reference in plain text format.
  • --theme <theme_name>: To change the current theme.
  • --explain <command>: For AI-generated summaries of command functionalities.

Customization

Users can personalize their SmartMan experience by defining an alias in their shell configuration, making SmartMan the default manual viewer. For example:

alias man='smartman'

This captures every use of the man command, providing the full SmartMan experience.

Themes

SmartMan includes built-in theme support, which can be easily customized through YAML files. Available themes enhance visual appeal and usability, including:

  • Default: A modern dark blue theme.
  • Dracula: Classic developer aesthetic.
  • Monokai: Vibrant, high-contrast layout.
  • Nord: Cool-toned design.
  • Catppuccin: Soft pastel visuals.

SmartMan is crafted for Linux users looking to enhance their command-line navigation and comprehension, making man pages more user-friendly and interactive.

0 comments

No comments yet.

Sign in to be the first to comment.