Back to skills
extension
Category: Development & EngineeringNo API key required

terminal-docs

Reference terminal documentation for TTY/PTY, streams, signals, and cross-platform patterns

personAuthor: jakexiaohubgithub

Terminal Documentation Reference Skill

Overview

This skill provides access to comprehensive terminal and shell systems documentation. Use this skill to look up exact configurations, code patterns, and best practices for terminal-related development.

Documentation Location

All documentation is stored in: /home/mwguerra/projects/mwguerra/claude-code-plugins/terminal-specialist/skills/terminal-docs/references/

Directory Structure

references/
├── 01-fundamentals.md      # TTY/PTY concepts, terminal stack, device files
├── 02-streams.md           # stdin, stdout, stderr, buffering behavior
├── 03-exit-codes.md        # Exit status, POSIX codes, signal exits
├── 04-shells.md            # Shell types, startup files, options
├── 05-dimensions.md        # Terminal size, SIGWINCH, resize handling
├── 06-modes.md             # Canonical/raw mode, termios flags
├── 07-job-control.md       # Sessions, process groups, background jobs
├── 08-environment.md       # TERM, PATH, locale, prompt variables
├── 09-signals.md           # Signal handling, keyboard signals
├── 10-escape-sequences.md  # ANSI codes, colors, cursor control
├── 11-redirection.md       # Pipes, file descriptors, here docs
├── 12-windows.md           # Windows console, ConPTY, PowerShell
├── 13-cross-platform.md    # Portable patterns, platform differences
└── 14-advanced.md          # tmux, screen, recording, graphics

Usage

When to Use This Skill

  1. Before implementing terminal-related functionality
  2. When debugging I/O or stream issues
  3. To verify correct escape sequence syntax
  4. To understand terminal mode behavior
  5. For signal handling patterns
  6. For cross-platform compatibility guidance

Search Workflow

  1. Identify Topic: Determine what documentation is needed
  2. Navigate to File: Go to relevant documentation file
  3. Read Documentation: Extract exact patterns
  4. Apply Knowledge: Use in implementation

Common Lookups

| Topic | File | |-------|------| | Terminal architecture | 01-fundamentals.md | | Stream buffering | 02-streams.md | | Exit codes | 03-exit-codes.md | | Shell configuration | 04-shells.md | | Terminal size | 05-dimensions.md | | Raw mode | 06-modes.md | | Job control | 07-job-control.md | | Environment variables | 08-environment.md | | Signal handling | 09-signals.md | | ANSI escape codes | 10-escape-sequences.md | | Pipes and redirection | 11-redirection.md | | Windows console | 12-windows.md | | Cross-platform | 13-cross-platform.md | | Multiplexers | 14-advanced.md |

Documentation Reading Pattern

When reading documentation:

  1. Find the right file: Match topic to documentation file
  2. Read the overview: Understand the concept
  3. Extract code examples: Copy exact patterns
  4. Note platform specifics: Consider Unix/Windows differences
  5. Check best practices: Apply safety and portability tips

Example Usage

Looking up ANSI Color Codes

  1. Navigate to 10-escape-sequences.md
  2. Find Colors section
  3. Extract:
    • 4-bit color codes (30-37, 40-47)
    • 256-color format
    • True color format
    • tput commands

Looking up Signal Handling

  1. Navigate to 09-signals.md
  2. Find relevant section (Bash, C, Python)
  3. Extract:
    • Signal handler setup
    • Signal-safe patterns
    • Cleanup handlers

Looking up Cross-Platform Input

  1. Navigate to 13-cross-platform.md
  2. Find Key Input section
  3. Extract:
    • Unix termios pattern
    • Windows msvcrt pattern
    • Platform detection code

Output

After reading documentation, provide:

  1. Exact code pattern from docs
  2. Platform considerations
  3. Best practices noted
  4. Safety/security notes
  5. Alternative approaches if applicable