commit d5e24ddb809d09e0fc2f2c5deaec9052825432da Author: github-actions[bot] Date: Mon Jul 7 15:22:29 2025 +0000 deploy: cf87b2f470202e72ede2238c0bc602502bc07160 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..5abfa7d --- /dev/null +++ b/404.html @@ -0,0 +1,16 @@ + + + + + +Page Not Found | Television + + + + + +

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

Architecture Documentation

NOTE: what follows has mostly been assembled using AI as an experiment and as a basis for further improvements. @lalvarezt and I (@alexpasmantier) have been proofreading it to make sure all the information is technically correct and really reflects the code's architecture, so that other developers may rely on it as a technical source of truth when getting started with the repo.

Overview

Television is a terminal fuzzy finder built with Rust. It uses async/await and separate loops for event handling, rendering, and background tasks to stay responsive.

High-Level Architecture

  ┌──────────────┐    ┌──────────────┐    ┌─────────────┐
  │ CLI & Config  │───►│ Application  │───►│   Output    │
  │              │    │ Orchestrator │    │             │
  └──────────────┘    └──────────────┘    └─────────────┘
                             │
                             ▼
    ┌─────────────────────────────────────────────────┐
    │                   Event Loops                   │
    │ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
    │ │ Event Loop  │ │ Render Loop │ │ Watch Timer │ │
    │ └─────────────┘ └─────────────┘ └─────────────┘ │
    └─────────────────────────────────────────────────┘
                            │
                            ▼
    ┌─────────────────────────────────────────────────┐
    │                 Core Components                 │
    │ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
    │ │  Television │ │  Channels   │ │  Previewer  │ │
    │ │   (State)   │ │  (Sources)  │ │             │ │
    │ └─────────────┘ └─────────────┘ └─────────────┘ │
    └─────────────────────────────────────────────────┘

How It Works

1. Startup

+ +

2. Runtime Event Flow

+ +

Core Components

Application Orchestrator (`app.rs`)

+ +

The main app that coordinates everything:

+
What it does:
+
- Manages app state and lifecycle
- Routes messages between loops using async channels
- Handles actions and state changes
- Starts and stops components
+
+
Key channels:
+
- action_tx/rx: Actions from events to main loop
- render_tx/rx: Rendering tasks to render loop
- event_rx: Events from event loop
- ui_state_tx/rx: UI state feedback from render loop
+

Event System

Event Loop (`loops/event_loop.rs`)

+ +

Purpose: Handles keyboard input, mouse events, and system signals
Input: Key presses, mouse clicks, terminal resize, Ctrl+C
Output: Events sent to main loop
Features: +
- Non-blocking event reading
- Clean shutdown handling
- Regular ticks for animations
+

Actions (`action.rs`)

All user interactions become actions:

pub enum Action {
    // Input actions
    AddInputChar(char),
    DeletePrevChar,

    // Navigation actions
    SelectNextEntry,
    SelectPrevEntry,

    // Application actions
    ConfirmSelection,
    ToggleRemoteControl,
    Render,

    // System actions
    Resize(u16, u16),
    Quit,
}

Television Core (`television.rs`)

The main state manager:

+
What it tracks:
+
- Current mode (Channel vs RemoteControl)
- Search pattern and matching settings
- Selected entries and picker state
- Preview state and handles
+
+
What it does:
+
- Pattern matching and filtering
- Entry selection and multi-selection
- Channel switching and mode changes
- Preview coordination
+

Channel System

+ + +

Channel Config (`channels/prototypes/`)

Channels are defined in TOML files:

[metadata]
name = "files"
description = "File finder"

[source]
command = "fd -t f"

[preview]
command = "bat --color=always '{}'"

[ui]
preview_panel = { size = 70 }

[keybindings]
shortcut = "f1"

Channel Runtime (`channels/channel.rs`)

Purpose: Run source commands and manage results
Features: +
- Async command execution with streaming results
- Fuzzy matching with nucleo
- Reload with debouncing
- Multiple source commands
+

Rendering System

Render Loop (`loops/render_loop.rs`)

Purpose: Update the UI without blocking the main loop
Input: Rendering tasks via channel
Output: Terminal updates and UI state feedback
Features: +
- 60 FPS frame rate capping to avoid CPU hogging
- Synchronized terminal updates
- Layout state tracking
+

Drawing (`draw.rs`)

Purpose: Coordinate UI component rendering
Components: +
- Input box with cursor
- Results list with selection
- Preview panel with content
- Status bar with info
- Remote control panel
+

Configuration System

+ +

Preview System (`previewer/`)

+ +

How it works: Separate async task for non-blocking previews
Communication: Request/response via channels
Features: +
- Command-based preview generation
- Caching and debouncing
- Error handling and fallbacks
- Syntax highlighting support
+

Watch Timer (`loops/watch_timer.rs`)

Purpose: Automatically reload channels
Features: +
- Configurable intervals per channel
- Auto start/stop on channel switch
- Handles missed ticks
+

Communication

+ +

Data Flow

One direction: Events → Actions → State changes → Render
Feedback: UI state info flows back for optimization
Async: All blocking operations happen in separate tasks

Design Patterns

1. Actor Model

Each major component runs independently and communicates via messages.

2. Command Pattern

All user interactions become Action enums.

3. Observer Pattern

UI state changes automatically trigger rendering updates.

4. Plugin Architecture

Channels are dynamically loaded from TOML config files.

Performance

Event Processing: Non-blocking with batched processing
Rendering: Capped at 60 FPS with dirty state tracking
Matching: Incremental fuzzy matching with nucleo
Preview: Async with caching and debouncing
Memory: Bounded result sets with efficient data structures

How to Extend

Adding New Channels

Create TOML config file
Define source command and output format
Add preview command and UI settings (optional)
Put in cable directory

Custom Keybindings

Global keybindings in main config
Channel-specific keybindings in channel config
Runtime updates via remote control

UI Themes

Color scheme definitions in theme files
Component-specific styling
Runtime theme switching

This architecture keeps things modular and fast, with clear separation between components and efficient async communication.

+ + \ No newline at end of file diff --git a/docs/Developers/patch-notes/index.html b/docs/Developers/patch-notes/index.html new file mode 100644 index 0000000..f613b9d --- /dev/null +++ b/docs/Developers/patch-notes/index.html @@ -0,0 +1,17 @@ + + + + + +Patch notes | Television + + + + + +

Patch notes

Patch notes for the latest release: link

+ + \ No newline at end of file diff --git a/docs/Developers/ui-features/index.html b/docs/Developers/ui-features/index.html new file mode 100644 index 0000000..4f4f924 --- /dev/null +++ b/docs/Developers/ui-features/index.html @@ -0,0 +1,130 @@ + + + + + +UI Features documentation | Television + + + + + +

UI Features documentation

Table of Contents

Overview
Architecture
Feature Components
State Management
Configuration System
Examples

Overview

The UI Features System allows control over UI components using two properties:

Enabled/Disabled: Whether the feature's functionality is available
Visible/Hidden: Whether the feature is displayed in the interface

This design pattern allows for UI management where features can exist in three meaningful states: Active (enabled and visible), Hidden (enabled but not visible), and Disabled (completely inactive).

Architecture

UI Features sit at the intersection of several core Television modules, acting as a central coordination point for UI state management.

Context Diagram

┌────────────┐    ┌────────────────────┐    ┌───────────────┐
│ CLI Module │───►│ UI Features System │◄───│ Config Module │
└────────────┘    └────────────────────┘    └───────────────┘
                            │
                            ▼
                    ┌───────────────┐
                    │ Screen/Layout │
                    │    Module     │
                    └───────────────┘
                            │
                            ▼
                      ┌───────────┐
                      │ UI Render │
                      │  System   │
                      └───────────┘

Feature Components

It currently supports four primary UI features, each with distinct functionality and use cases.

In this view you can see the Preview, Help Panel, and Status Bar

╭──────────────────────── Channel ─────────────────────────╮╭───────────────────────── PREVIEW ────────────────────────╮
│>                                                  1 / 1  ││                                                         ▲│
╰──────────────────────────────────────────────────────────╯│                                                         █│
╭──────────────────────── Results ─────────────────────────╮│                                                         ║│
│> TELEVISION                                              ││                                                         ║│
│                                                          ││                                                         ║│
│                                                          ││                                                         ║│
│                                                          ││                                                         ║│
│                                                          ││                  ╭─────────────── Help ────────────────╮║│
│                                                          ││                  │ Global                              │║│
│                                                          ││                  │ Quit: Esc                           │║│
│                                                          ││                  │ Quit: Ctrl-c                        │║│
│                                                          ││                  │ Toggle preview: Ctrl-o              │║│
│                                                          ││                  │ Toggle help: Ctrl-h                 │║│
│                                                          ││                  │ Toggle status bar: F12              │║│
│                                                          ││                  │                                     │║│
│                                                          ││                  │ Channel                             │║│
│                                                          ││                  │ Navigate up: Up                     │║│
│                                                          ││                  │ Navigate up: Ctrl-p                 │║│
│                                                          ││                  │ Navigate up: Ctrl-k                 │║│
│                                                          ││                  │ Navigate down: Down                 │║│
│                                                          ││                  │ Navigate down: Ctrl-n               │║│
│                                                          ││                  │ Navigate down: Ctrl-j               │║│
│                                                          ││                  │ ...                                 │║│
│                                                          ││                  ╰─────────────────────────────────────╯▼│
╰──────────────────────────────────────────────────────────╯╰──────────────────────────────────────────────────────────╯
  CHANNEL custom           [Hint] Remote Control: Ctrl-t • Hide Preview: Ctrl-o • Help: Ctrl-h                  v0.00.0

And here you can see the Remote Control

╭────────────────────────────────────────────────────── Channel ───────────────────────────────────────────────────────╮
│>                                                                                                               1 / 1 │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭────────────────────────────────────────────────────── Results ───────────────────────────────────────────────────────╮
│> TELEVISION                                                                                                          │
│                                                                                                                      │
│                      ╭──────── Channels ─────────╮╭────── Description ───────╮                                       │
│                      │> alias                    ││A channel to select from  │  _____________                        │
│                      │                           ││shell aliases             │ /             \                       │
│                      │                           ││                          │ | (*)     (#) |                       │
│                      │                           ││                          │ |             |                       │
│                      │                           ││                          │ | (1) (2) (3) |                       │
│                      │                           ││                          │ | (4) (5) (6) |                       │
│                      │                           ││                          │ | (7) (8) (9) |                       │
│                      │                           ││                          │ |      _      |                       │
│                      │                           ││                          │ |     | |     |                       │
│                      │                           ││                          │ |  (_¯(0)¯_)  |                       │
│                      │                           ││                          │ |     | |     |                       │
│                      │                           ││                          │ |      ¯      |                       │
│                      │                           ││                          │ |             |                       │
│                      │                           ││                          │ | === === === |                       │
│                      ╰───────────────────────────╯╰──────────────────────────╯ |             |                       │
│                      ╭───────── Search ──────────╮╭─── Requirements [OK] ────╮ |     TV      |                       │
│                      │>                          ││                          │ `-------------´                       │
│                      ╰───────────────────────────╯╰──────────────────────────╯                                       │
│                                                                                                                      │
│                                                                                                                      │
│                                                                                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
  REMOTE                              [Hint] Back to Channel: Ctrl-t • Help: Ctrl-h                             v0.00.0

Preview Panel

Displays contextual information about the currently selected entry

Default State: Enabled and Visible +Configuration Files options:

size: Width percentage (1-99)
header: Optional template for panel header
footer: Optional template for panel footer
scrollbar: Whether to show scroll indicators

CLI Flags: --no-preview, --hide-preview, --show-preview, --preview-* flags

Status Bar

Shows application status, mode information, and available actions

Default State: Enabled and Visible +Configuration:

separator_open: Opening separator character/string
separator_close: Closing separator character/string

CLI Controls: --no-status-bar, --hide-status-bar, --show-status-bar

Help Panel

Displays contextual help and keyboard shortcuts

Default State: Enabled but Hidden +Configuration:

show_categories: Whether to group shortcuts by category

CLI Controls: --no-help-panel, --hide-help-panel, --show-help-panel

Remote Control

Provides channel switching and management interface

Default State: Enabled but Hidden +Configuration:

show_channel_descriptions: Include channel descriptions in listing
sort_alphabetically: Sort channels alphabetically vs. by usage

CLI Controls: --no-remote, --hide-remote, --show-remote

State Management

Logical state transitions with are enforced with built-in constraints:

┌─────────────┐    enable()     ┌─────────────┐
│  Disabled   │────────────────►│   Active    │
│  enabled=F  │                 │  enabled=T  │
│  visible=F  │                 │  visible=T  │
└─────────────┘                 └─────────────┘
       ▲                               │
       │                               │ hide()
       │                               ▼
       │                        ┌─────────────┐
       └────────────────────────│   Hidden    │
         disable()              │  enabled=T  │
                                │  visible=F  │
                                └─────────────┘
                                       │
                                       │ show()
                                       ▼
                                ┌─────────────┐
                                │   Active    │
                                │  enabled=T  │
                                │  visible=T  │
                                └─────────────┘

Configuration System

The UI Features system configuration follows a layered priority system:

CLI Flags (Highest Priority)
Channel Configuration
User Configuration File
Built-in Defaults (Lowest Priority)

Configuration Formats

TOML Configuration Syntax

[ui.features]
preview_panel = { enabled = true, visible = true }
help_panel = { enabled = true, visible = false }
status_bar = { enabled = true, visible = true }
remote_control = { enabled = true, visible = false }

[ui.preview_panel]
size = 50
header = "{}"
footer = ""
scrollbar = true

[ui.status_bar]
separator_open = ""
separator_close = ""

[ui.remote_control]
show_channel_descriptions = true
sort_alphabetically = true

Configuration Inheritance

User Global Configuration

# ~/.config/television/config.toml
[ui.features]
help_panel = { enabled = true, visible = true }  # Always show help for learning

Channel-Level Configuration

# ~/.config/television/cable/development.toml
[ui.features]
preview_panel = { enabled = true, visible = true }
status_bar = { enabled = true, visible = false }  # Hidden by default for focus

Runtime Override Examples

# Override channel defaults
tv development --show-status-bar --hide-preview

# Force features on/off
tv files --no-remote --show-help-panel

# Mixed visibility control
tv git-log --hide-status-bar --show-preview

Default UI Feature States

UI Feature	Default Enabled	Default Visible	Rationale
Preview Panel	✅	✅	Core functionality
Status Bar	✅	✅	Shows mode and contextual hint to the user
Help Panel	✅	❌	Available on-demand to avoid clutter
Remote Control	✅	❌	Available on-demand, disrupts regular operation

Feature State Persistence

What Persists Across Sessions

✅ Configuration file settings - Feature states defined in ~/.config/television/config.toml
✅ Channel-specific defaults - Feature configurations built into channel definitions

What Does Not Persist

❌ Runtime toggles - Keyboard shortcuts like Tab (preview) or F2 (status bar) are session-only
❌ CLI flag overrides - --hide-preview, --show-status-bar etc. apply only to current session
❌ Temporary state changes - Any feature visibility changes made during application use

Examples

Basic Feature Control

Hide Preview Panel

tv files --hide-preview

Disable All Optional Features

tv files --no-preview --no-status-bar --no-remote --no-help-panel

Show All Features

tv files --show-preview --show-status-bar --show-help-panel

Channel-Specific Configuration

Create Development Channel with Custom Features

# ~/.config/television/cable/dev-focused.toml
[ui.features]
preview_panel = { enabled = true, visible = true }
status_bar = { enabled = true, visible = false }    # Clean interface
help_panel = { enabled = true, visible = false }    # Help on-demand
remote_control = { enabled = false }                # Single-channel focus

Usage

tv dev-focused /path/to/project

Runtime Feature Management

Quick Interface Cleanup

# Start with full interface
tv files

# Runtime toggles (using default keybindings):
# Ctrl+O - Toggle preview panel
# F12    - Toggle status bar
# Ctrl-H - Toggle help panel

Overview
Architecture
- Context Diagram
Feature Components
State Management
Configuration System
Examples

+ + \ No newline at end of file diff --git a/docs/Users/channels/index.html b/docs/Users/channels/index.html new file mode 100644 index 0000000..74ffa09 --- /dev/null +++ b/docs/Users/channels/index.html @@ -0,0 +1,73 @@ + + + + + +Channels | Television + + + + + +

Channels

Quick start

Channels are short configuration recipes that typically dictate what tv should search through and what's displayed on the screen along with various other options.

Any given channel consists of a single TOML file.

Example: the default files channel

[metadata]
name = "files"
description = "A channel to select files and directories"
requirements = ["fd", "bat"]

[source]
command = "fd -t f"

[preview]
command = "bat -n --color=always '{}'"
env = { BAT_THEME = "ansi" }

[keybindings]
shortcut = "f1"

Default location on your system

Channels live in the cable directory inside your television configuration directory.

Example:

/home/user/.config/television
├── config.toml
└── cable
    ├── files.toml
    ├── env.toml
    ├── alias.toml
    ├── git-repos.toml
    └── text.toml

Community-maintained channels

The repository hosts a list of community-maintained channels which you can get and install to your cable directory using:

tv update-channels

Invocation

Channels may be invoked:

directly from the cli:

tv files

+
using the remote control: +
+
+
on the fly:
+

tv --source-command 'fd -t f .' --preview-command 'bat -n --color=always {}' --preview-size 70

Creating your own channels

Create a new TOML file in your cable directory:

touch ~/.config/television/cable/my-awesome-channel.toml

Fill out the minimum required fields:

[metadata]
name = "my-awesome-channel"

[source]
command = "aws s3 ls my-bucket"

Launch tv with your new channel (or select it via the remote control):

tv my-awesome-channel

The complete channel format spec can be found below.

Templating syntax

Several channel fields can be formatted dynamically using the syntax described in the string-pipeline crate.

Here's a quick TLDR if you're feeling lazy:

Basic transformations:

# Extract middle items: "a,b,c,d,e"
"{split:,:1..3}"
# Output: "b,c"

# Clean and format names: "  john  , jane , bob  "
'{split:,:..|map:{trim|upper|append:!}}'
# Output: "JOHN!,JANE!,BOB!"

# Extract numbers and pad with zeros: "item1,thing22,stuff333"
'{split:,:..|map:{regex_extract:\d+|pad:3:0:left}}'
# Output: "001,022,333"

More niche use-cases:

# Filter files, format as list: "app.py,readme.md,test.py,data.json"
'{split:,:..|filter:\.py$|sort|map:{prepend:• }|join:\n}'
# Output: "• app.py\n• test.py"

# Extract domains from URLs: "https://github.com,https://google.com"
'{split:,:..|map:{regex_extract://([^/]+):1|upper}}'
# Output: "GITHUB.COM,GOOGLE.COM"

# Debug complex processing: "apple Banana cherry Date"
"{split: :..|filter:^[A-Z]|sort:desc}"
# Output: Date,Banana

Channel specification

high-level sections

[metadata]
# general channel information

[source]
# this defines what we're searching through

[preview]
# for each result, maybe display a preview

[ui]
# customize the UI

[keybindings]
# customize keybindings

`[metadata]`

[metadata]
name = "text"
description = "A short description about what my channel does"
requirements = ["rg", "bat"]  # any binary requirements my channel needs

`[source]`

[source]
command = "rg . --no-heading --line-number"
display = "[{split:\\::..2}]\t{split:\\::2}"  # what's displayed in the UI
output = "{split:\\::..2}"  # what's outputed on selection

`[preview]`

[preview]
command = 'bat -n --color=always {split:\::0}'
env = { BAT_THEME = "ansi" }  # extra envs to use when generating preview
offset = '{split:\::1}'  # extracts preview offset information from the entry

`[ui]`

[ui]
ui_scale = 80  # use 80% of available screen
layout = "portrait"
input_bar_position = "bottom"
input_header = "Search:"

[ui.preview_panel]
size = 40  # 40%
header = "{}"  # show the currently selected entry
footer = "my awesome footer"
scrollbar = false

[ui.status_bar]
separator_open = "<"
separator_close = ">"

[ui.help_panel]
show_categories = true

[ui.remote_control]
show_channel_descriptions = true
sort_alphabetically = true

[ui.features]
preview_panel = { enabled = true, visible = true }
remote_control = { enabled = true, visible = false }
help_panel = { enabled = true, visible = false }
status_bar = { enabled =true, visible = true }

`[keybindings]`

[keybindings]
shortcut = "f1"  # `f1` will automatically switch to this channel

quit = ["esc", "ctrl-c"]
select_next_entry = "ctrl-j"
select_prev_entry = "ctrl-k"
confirm_selection = "ctrl-y"

See actions.rs for a list of available actions.

Quick start
Default location on your system
Community-maintained channels
Invocation
Creating your own channels
Templating syntax
Channel specification

+ + \ No newline at end of file diff --git a/docs/Users/cli/index.html b/docs/Users/cli/index.html new file mode 100644 index 0000000..9aa79ed --- /dev/null +++ b/docs/Users/cli/index.html @@ -0,0 +1,505 @@ + + + + + +CLI Reference | Television + + + + + +

CLI Reference

Television (tv) is a cross-platform, fast and extensible general purpose fuzzy finder TUI. This document provides a comprehensive reference for all CLI options, modes, restrictions, and usage patterns.

Overview
Operating Modes
Basic Usage
Arguments
Options
Subcommands
Usage Rules and Restrictions
Configuration
Template System
Examples

Overview

Television supports two primary operating modes that determine how CLI flags are interpreted and validated:

Channel Mode: When a channel is specified, the application uses the channel's configuration as a base and CLI flags act as overrides
Ad-hoc Mode: When no channel is specified, the application creates a custom channel from CLI flags with stricter validation

Operating Modes

Channel Mode

Activated when: A channel name is provided as the first argument or via --autocomplete-prompt

Behavior:

Channel provides base configuration (source commands, preview commands, UI settings)
CLI flags act as overrides to channel defaults
More permissive validation - allows most combination of flags
Minimal dependency checking since channel provides sensible defaults

Example:

tv files --preview-command "bat -n --color=always '{}'"

Ad-hoc Mode

Activated when: No channel is specified and no --autocomplete-prompt is used

Behavior:

Creates a custom channel on-the-fly from CLI flags
Requires --source-command to generate any entries
Stricter validation ensures necessary components are present
All functionality depends on explicitly provided flags

Example:

tv --source-command "find . -name '*.rs'" --preview-command "bat -n --color=always '{}'"

Basic Usage

tv [OPTIONS] [CHANNEL] [PATH]

Arguments

Television has intelligent positional argument handling with special path detection logic.

Position 1: `[CHANNEL]`

Purpose: Channel name to activate Channel Mode

+
Standard behavior: When a valid channel name is provided, activates Channel Mode
+
+
Special path detection: If the argument exists as a path on the filesystem, it's automatically treated as a working directory instead
+
+
Effect when path detected: Switches to Ad-hoc Mode and uses the path as the working directory
+
+
Required: No (falls back to default_channel from the global config)
+

Examples:

tv files               # Uses 'files' channel
tv /home/user/docs     # Auto-detects path, uses as working directory
tv ./projects          # Auto-detects relative path

Position 2: `[PATH]`

Purpose: Working directory to start in

Behavior: Sets the working directory for the application
Required: No
Precedence: Only used if Position 1 was not detected as a path
Default: Current directory
Example: tv files /home/user/projects

⚡ Smart Path Detection Logic

Television automatically detects when the first argument is a filesystem path:

Path Check: If Position 1 exists as a file or directory on the filesystem
Mode Switch: Automatically switches to Ad-hoc Mode (no channel)
Directory Assignment: Uses the detected path as the working directory
Requirement: When this happens, --source-command becomes required (Ad-hoc Mode rules apply)

Examples of Smart Detection:

# No arguments - uses default_channel from config
tv

# Channel name provided - Channel Mode
tv files

# Existing path provided - triggers path detection → uses default_channel
tv /home/user/docs    # Uses default_channel in /home/user/docs directory

# Non-existent path - treated as channel name → error if channel doesn't exist
tv /nonexistent/path  # Error: Channel not found

# Channel + explicit working directory - Channel Mode
tv files /home/user/docs

# The key nuance: same name, different behavior based on filesystem
tv myproject          # Channel Mode (if 'myproject' is a channel name)
tv ./myproject        # Channel Mode with default_channel (if './myproject' directory exists)

# Ambiguous case - path detection takes precedence
tv docs               # If 'docs' directory exists → default_channel + path detection
                      # If 'docs' directory doesn't exist → 'docs' channel

+
💡 Tip: This smart detection makes Television intuitive - you can just specify a directory and it automatically knows you want to work in that location.
+

Options

Television's options are organized by functionality. Each option behaves differently depending on whether you're using Channel Mode (with a channel specified) or Ad-hoc Mode (no channel).

🎯 Source and Data Options

`--source-command <STRING>`

Purpose: Defines the command that generates entries for the picker

Channel Mode: Overrides the channel's default source command
Ad-hoc Mode: ⚠️ Required - without this, no entries will be generated
Example: --source-command "find . -name '*.py'"

`--source-display <STRING>`

Purpose: Template for formatting how entries appear in the results list

Both Modes: Same behavior
Requires: --source-command (in ad-hoc mode)
Example: --source-display "{split:/:-1} ({split:/:0..-1|join:-})"

`--source-output <STRING>`

Purpose: Template for formatting the final output when an entry is selected

Both Modes: Same behavior
Requires: --source-command (in ad-hoc mode)
Example: --source-output "code {}"

👁️ Preview Options

`--no-preview`

Purpose: Disable preview feature, toggling is not possible

Both Modes: Same behavior
Conflicts: Cannot be used with any --preview-* or --*-preview flags
Use Case: Minimal interface

`--hide-preview`

Purpose: Starts the interface with the preview panel hidden

Both Modes: Same behavior
Conflicts: Cannot be used with --no-preview or --show-preview
Use Case: Start with clean interface, toggle preview later

`--show-preview`

Purpose: Starts the interface with the preview panel visible

Both Modes: Same behavior
Conflicts: Cannot be used with --no-preview or --hide-preview
Use Case: Ensure preview is always available

`-p, --preview-command <STRING>`

Purpose: Command to generate preview content for the selected entry

Both Modes: Same behavior
Requires: --source-command (in ad-hoc mode)
Conflicts: Cannot be used with --no-preview
Example: --preview-command "bat -n --color=always '{}'"

`--preview-header <STRING>`

Purpose: Template for text displayed above the preview panel

Both Modes: Same behavior
Requires: --preview-command (in ad-hoc mode)
Conflicts: Cannot be used with --no-preview
Example: --preview-header "File: {split:/:-1|upper}"

`--preview-footer <STRING>`

Purpose: Template for text displayed below the preview panel

Both Modes: Same behavior
Requires: --preview-command (in ad-hoc mode)
Conflicts: Cannot be used with --no-preview

`--preview-offset <STRING>`

Purpose: Template that determines the scroll position in the preview

Both Modes: Same behavior
Requires: --preview-command (in ad-hoc mode)
Conflicts: Cannot be used with --no-preview
Example: --preview-offset "10" (start at line 10)

`--preview-size <INTEGER>`

Purpose: Width of the preview panel as a percentage

Both Modes: Same behavior
Default: 50% of screen width
Range: 1-99
Conflicts: Cannot be used with --no-preview

ℹ️ Status Bar Options

`--no-status-bar`

Purpose: Disable status bar feature, toggling is not possible

Both Modes: Same behavior
Conflicts: Cannot be used with --hide-status-bar or --show-status-bar
Use Case: Minimal interface

`--hide-status-bar`

Purpose: Starts the interface with the status bar hidden

Both Modes: Same behavior
Conflicts: Cannot be used with --no-status-bar or --show-status-bar
Use Case: Clean interface with option to show status later

`--show-status-bar`

Purpose: Starts the interface with the status bar visible

Both Modes: Same behavior
Conflicts: Cannot be used with --no-status-bar or --hide-status-bar
Use Case: Ensure status information is always available

📡 Remote Control Options

`--no-remote`

Purpose: Disable remote control feature, toggling is not possible

Both Modes: Same behavior
Conflicts: Cannot be used with --hide-remote or --show-remote
Use Case: Single-channel mode, embedded usage

`--hide-remote`

Purpose: Starts the interface with the remote control hidden

Both Modes: Same behavior
Conflicts: Cannot be used with --no-remote or --show-remote
Use Case: Start in single-channel mode, access remote later

`--show-remote`

Purpose: Starts the interface with the remote control visible

Both Modes: Same behavior
Conflicts: Cannot be used with --no-remote or --hide-remote
Use Case: Ensure channel switching is always available

❓ Help Panel Options

`--no-help-panel`

Purpose: Disable help panel feature, toggling is not possible

Both Modes: Same behavior
Conflicts: Cannot be used with --hide-help-panel or --show-help-panel
Use Case: Minimal interface

`--hide-help-panel`

Purpose: Starts the interface with the help panel hidden

Both Modes: Same behavior
Conflicts: Cannot be used with --no-help-panel or --show-help-panel
Use Case: Clean interface with option to show help later

`--show-help-panel`

Purpose: Starts the interface with the help panel visible

Both Modes: Same behavior
Conflicts: Cannot be used with --no-help-panel or --hide-help-panel
Use Case: Ensure help information is always available

🎨 Interface and Layout Options

`--layout <LAYOUT>`

Purpose: Controls the overall interface orientation

Both Modes: Same behavior
Values: landscape (side-by-side), portrait (stacked)
Default: landscape

`--input-header <STRING>`

Purpose: Template for text displayed above the input field

Both Modes: Same behavior
Default: Channel name (channel mode) or empty (ad-hoc mode)
Example: --input-header "Search files:"

`--ui-scale <INTEGER>`

Purpose: Scales the entire interface size

Both Modes: Same behavior
Default: 100%
Range: 10-100%
Use Case: Adapt to different screen sizes or preferences

`--height <INTEGER>`

Purpose: Sets a fixed height for non-fullscreen mode

Both Modes: Same behavior
Range: 6 or higher (minimum UI height required)
Conflicts: Cannot be used with --inline
Use Case: Precise control over interface height

`--width <INTEGER>`

Purpose: Sets a fixed width for non-fullscreen mode

Both Modes: Same behavior
Range: 10 or higher (minimum UI width required)
Requires: Must be used with --inline or --height
Use Case: Precise control over interface width

`--inline`

Purpose: Uses all available empty space at the bottom of the terminal

Both Modes: Same behavior
Behavior: Automatically uses all available space below the cursor, minimum height is ensured
Conflicts: Cannot be used with --height
Use Case: Use of all available space without entering fullscreen mode

⌨️ Input and Interaction Options

`-i, --input <STRING>`

Purpose: Pre-fills the input prompt with specified text

Both Modes: Same behavior
Use Case: Continue a previous search or provide default query
Example: -i "main.py"

`-k, --keybindings <STRING>`

Purpose: Overrides default keyboard shortcuts

Both Modes: Same behavior
Format: action1=["key1","key2"];action2=["key3"]
Example: -k 'quit=["q","esc"];select=["enter","space"]'

`--exact`

Purpose: Changes matching behavior from fuzzy to exact substring matching

Both Modes: Same behavior
Default: Fuzzy matching
Use Case: When you need precise substring matches

⚡ Selection Behavior Options

+
Note: These options are mutually exclusive - only one can be used at a time.
+

`--select-1`

Purpose: Automatically selects and returns the entry if only one is found

Both Modes: Same behavior
Use Case: Scripting scenarios where single results should be auto-selected

`--take-1`

Purpose: Takes the first entry after loading completes

Both Modes: Same behavior
Use Case: Scripts that always want the first/best result

`--take-1-fast`

Purpose: Takes the first entry immediately as it appears

Both Modes: Same behavior
Use Case: Maximum speed scripts that don't care about all options

⚙️ Performance and Monitoring Options

`-t, --tick-rate <FLOAT>`

Purpose: Controls how frequently the interface updates (times per second)

Both Modes: Same behavior
Default: Auto-calculated based on system performance
Validation: Must be positive number
Example: --tick-rate 30 (30 updates per second)

`--watch <FLOAT>`

Purpose: Automatically re-runs the source command at regular intervals

Both Modes: Same behavior
Default: 0 (disabled)
Units: Seconds between updates
Conflicts: Cannot be used with selection options (--select-1, --take-1, --take-1-fast)
Example: --watch 2.0 (update every 2 seconds)

📁 Directory and Configuration Options

`[PATH]` (Positional Argument 2)

Purpose: Sets the working directory for the command

Both Modes: Same behavior
Default: Current directory
Example: tv files /home/user/projects

`--config-file <PATH>`

Purpose: Uses a custom configuration file instead of the default

Both Modes: Same behavior
Default: ~/.config/tv/config.toml (Linux/macOS) or %APPDATA%\tv\config.toml (Windows)
Use Case: Multiple configurations for different workflows

`--cable-dir <PATH>`

Purpose: Uses a custom directory for channel definitions

Both Modes: Same behavior
Default: ~/.config/tv/cable/ (Linux/macOS) or %APPDATA%\tv\cable\ (Windows)
Use Case: Custom channel collections or shared team channels

📚 History Options

`--global-history`

Purpose: Enables global history for the current session

Both Modes: Same behavior
Default: Channel-specific history (scoped to current channel)
Use Case: Cross-channel workflow when you want to see all recent searches
Example: tv files --global-history

🔧 Special Mode Options

`--autocomplete-prompt <STRING>`

Purpose: ⚡ Activates Channel Mode - Auto-detects channel from shell command

Effect: Switches to Channel Mode automatically
Behavior: Analyzes the provided command to determine appropriate channel
Conflicts: Cannot be used with [CHANNEL] positional argument
Use Case: Shell integration and smart channel detection
Example: --autocomplete-prompt "git log --oneline"

Subcommands

`list-channels`

Lists all available channels in the cable directory.

tv list-channels

`init <SHELL>`

Generates shell completion script for the specified shell.

Supported shells: bash, zsh, fish, powershell, cmd

tv init zsh > ~/.zshrc.d/tv-completion.zsh

`update-channels`

Downloads the latest channel prototypes from GitHub.

tv update-channels

Usage Rules and Restrictions

+
Note: Detailed requirements and conflicts for each flag are covered in the Options section above. This section provides a high-level overview of the key rules.
+

🎯 Ad-hoc Mode Requirements

When using Television without a channel, certain flags become mandatory:

--source-command is required - without this, no entries will be generated
Preview dependencies - all --preview-* flags require --preview-command to be functional
Source formatting dependencies - --source-display and --source-output require --source-command

🚫 Mutually Exclusive Options

These option groups cannot be used together:

Selection behavior: Only one of --select-1, --take-1, or --take-1-fast
Preview control: --no-preview conflicts with all --preview-* flags and --hide-preview/--show-preview
Preview visibility: Only one of --no-preview, --hide-preview, or --show-preview
Status bar control: Only one of --no-status-bar, --hide-status-bar, or --show-status-bar
Remote control: Only one of --no-remote, --hide-remote, or --show-remote
Help panel control: Only one of --no-help-panel, --hide-help-panel, or --show-help-panel
Channel selection: Cannot use both [CHANNEL] argument and --autocomplete-prompt
Watch vs selection: --watch cannot be used with auto-selection flags

✅ Channel Mode Benefits

Channels provide sensible defaults, making the tool more flexible:

Preview and source flags work independently (channel provides missing pieces)
All UI options have reasonable defaults
Less strict validation since channels fill in the gaps

Configuration

⚡ Configuration Priority

Television uses a layered configuration system where each layer can override the previous:

CLI flags - Highest priority, overrides everything
Channel configuration - Channel-specific settings
User config file - Personal preferences
Built-in defaults - Fallback values

📁 Configuration Locations

User Configuration File

Linux/macOS: ~/.config/tv/config.toml
Windows: %APPDATA%\tv\config.toml

Channel Definitions (Cable Directory)

Linux/macOS: ~/.config/tv/cable/
Windows: %APPDATA%\tv\cable\

+
Tip: Use --config-file and --cable-dir flags to override these default locations
+

🎛️ Feature Configuration

Television features support dual-state control: enabled/disabled and visible/not visible.

+
📖 For more details on the ui feature documentation, see ui-features.md.
+

Quick Feature Overview

Television supports four main UI features:

Feature	Purpose	Default State	CLI Controls
Preview Panel	Shows contextual information for selected entries	Enabled & Visible	`--no-preview`, `--hide-preview`, `--show-preview`
Status Bar	Displays application status and available actions	Enabled & Visible	`--no-status-bar`, `--hide-status-bar`, `--show-status-bar`
Help Panel	Shows contextual help and keyboard shortcuts	Enabled but Hidden	`--no-help-panel`, `--hide-help-panel`, `--show-help-panel`
Remote Control	Provides channel switching interface	Enabled but Hidden	`--no-remote`, `--hide-remote`, `--show-remote`

CLI Feature Override Examples

# Control visibility while keeping functionality
tv files --hide-preview --show-status-bar

# Force features on
tv files --show-preview --show-remote

# Disable completely
tv files --no-preview --no-remote

# Mixed control
tv files --hide-status-bar --show-remote

Template System

Television uses a powerful template system for dynamic content generation. Templates are enclosed in curly braces {} and support complex operations.

Template-Enabled Flags

Flag Category	Flags Using Templates
Source	`--source-command`, `--source-display`, `--source-output`
Preview	`--preview-command`, `--preview-offset`
Headers	`--input-header`, `--preview-header`, `--preview-footer`

Basic Template Syntax

Templates support a wide range of operations that can be chained together:

{operation1|operation2|operation3}

Core Template Operations

Operation	Description	Example
`{}`	Full entry (passthrough)	`{}` → original entry
`{split:SEPARATOR:RANGE}`	Split text and extract parts	`{split:/:‑1}` → last path component
`{upper}`	Convert to uppercase	`{upper}` → "HELLO"
`{lower}`	Convert to lowercase	`{lower}` → "hello"
`{trim}`	Remove whitespace	`{trim}` → "text"
`{append:TEXT}`	Add text to end	`{append:.txt}` → "file.txt"
`{prepend:TEXT}`	Add text to beginning	`{prepend:/home/}` → "/home/file"

Advanced Template Operations

Operation	Description	Example
`{replace:s/PATTERN/REPLACEMENT/FLAGS}`	Regex find and replace	`{replace:s/\\.py$/.backup/}`
`{regex_extract:PATTERN}`	Extract matching text	`{regex_extract:\\d+}` → extract numbers
`{filter:PATTERN}`	Keep items matching pattern	`{split:,:..\|filter:^test}`
`{sort}`	Sort list items	`{split:,:..\|sort}`
`{unique}`	Remove duplicates	`{split:,:..\|unique}`
`{join:SEPARATOR}`	Join list with separator	`{split:,:..\|join:-}`

Template Examples

# File path manipulation
{split:/:-1}                    # Get filename from path
{split:/:0..-1|join:/}          # Get directory from path

# Text processing
{split: :..|map:{upper}|join:_} # "hello world" → "HELLO_WORLD"
{trim|replace:s/\s+/_/g}        # Replace spaces with underscores

# Data extraction
{regex_extract:@(.+)}           # Extract email domain
{split:,:..|filter:^[A-Z]}      # Filter items starting with uppercase

Range Specifications

Syntax	Description
`N`	Single index (0-based)
`N..M`	Range exclusive (items N to M-1)
`N..=M`	Range inclusive (items N to M)
`N..`	From N to end
`..M`	From start to M-1
`..`	All items
`-1`	Last item
`-N`	N-th from end

For complete template documentation, see the Template System Documentation.

Examples

+
Note: More detailed examples with explanations are included in each option's documentation above.
+

🎯 Quick Start Examples

Channel Mode (Recommended)

# Basic usage - use built-in channels
tv files                    # Browse files in current directory
tv git-log                  # Browse git commit history
tv docker-images            # Browse Docker images

# Channel + customization
tv files --preview-command "bat -n --color=always '{}'"
tv git-log --layout portrait

# Feature visibility control
tv files --hide-preview --show-status-bar    # Clean interface, status visible
tv files --show-remote                       # Force remote control visible

Ad-hoc Mode (Custom Commands)

# Simple custom finder
tv --source-command "find . -name '*.md'"

# Live system monitoring with hidden UI elements
tv --source-command "ps aux | tail -n +2" \
   --watch 1.0 \
   --hide-preview \
   --hide-status-bar

# Clean interface with selective visibility
tv --source-command "docker ps -a" \
   --hide-preview \
   --show-status-bar

Table of Contents
Overview
Operating Modes
- Channel Mode
- Ad-hoc Mode
Basic Usage
- Arguments
Options
Subcommands
Usage Rules and Restrictions
Configuration
Template System
Examples
- 🎯 Quick Start Examples

+ + \ No newline at end of file diff --git a/docs/Users/community-channels-unix/index.html b/docs/Users/community-channels-unix/index.html new file mode 100644 index 0000000..1c028b4 --- /dev/null +++ b/docs/Users/community-channels-unix/index.html @@ -0,0 +1,107 @@ + + + + + +🍿 Community Channels (unix) | Television + + + + + +

🍿 Community Channels (unix)

alias

A channel to select from shell aliases

Requirements: None

Code: alias.toml

[metadata]
name = "alias"
description = "A channel to select from shell aliases"

[source]
command = "alias"
interactive = true
output = "{split:=:0}"

bash-history

A channel to select from your bash history

Requirements: bash

Code: bash-history.toml

[metadata]
name = "bash-history"
description = "A channel to select from your bash history"
requirements = [ "bash",]

[source]
command = "sed '1!G;h;$!d' ${HISTFILE:-${HOME}/.bash_history}"

dirs

A channel to select from directories

Requirements: fd

Code: dirs.toml

[metadata]
name = "dirs"
description = "A channel to select from directories"
requirements = [ "fd",]

[source]
command = [ "fd -t d", "fd -t d --hidden",]

[preview]
command = "ls -la --color=always {}"

[keybindings]
shortcut = "f2"

docker-images

A channel to select from Docker images

Requirements: docker, jq

Code: docker-images.toml

[metadata]
name = "docker-images"
description = "A channel to select from Docker images"
requirements = [ "docker", "jq",]

[source]
command = "docker images --format '{{.Repository}}:{{.Tag}} {{.ID}}'"
output = "{split: :-1}"

[preview]
command = "docker image inspect {split: :-1} | jq -C"

dotfiles

A channel to select from your user's dotfiles

Requirements: fd, bat

Code: dotfiles.toml

[metadata]
name = "dotfiles"
description = "A channel to select from your user's dotfiles"
requirements = [ "fd", "bat",]

[source]
command = "fd -t f . $HOME/.config"

[preview]
command = "bat -n --color=always '{}'"

env

A channel to select from environment variables

Requirements: None

Code: env.toml

[metadata]
name = "env"
description = "A channel to select from environment variables"

[source]
command = "printenv"
output = "{split:=:1..}"

[preview]
command = "echo '{split:=:1..}'"

[ui]
layout = "portrait"

[keybindings]
shortcut = "f3"

[ui.preview_panel]
size = 20
header = "{split:=:0}"

files

A channel to select files and directories

Requirements: fd, bat

Code: files.toml

[metadata]
name = "files"
description = "A channel to select files and directories"
requirements = [ "fd", "bat",]

[source]
command = [ "fd -t f", "fd -t f -H",]

[preview]
command = "bat -n --color=always '{}'"

[keybindings]
shortcut = "f1"

[preview.env]
BAT_THEME = "ansi"

fish-history

A channel to select from your fish history

Requirements: fish

Code: fish-history.toml

[metadata]
name = "fish-history"
description = "A channel to select from your fish history"
requirements = [ "fish",]

[source]
command = "fish -c 'history'"

git-branch

A channel to select from git branches

Requirements: git

Code: git-branch.toml

[metadata]
name = "git-branch"
description = "A channel to select from git branches"
requirements = [ "git",]

[source]
command = "git --no-pager branch --all --format=\"%(refname:short)\""
output = "{split: :0}"

[preview]
command = "git show -p --stat --pretty=fuller --color=always {0}"

git-diff

A channel to select files from git diff commands

Requirements: git

Code: git-diff.toml

[metadata]
name = "git-diff"
description = "A channel to select files from git diff commands"
requirements = [ "git",]

[source]
command = "git diff --name-only HEAD"

[preview]
command = "git diff HEAD --color=always -- {}"

git-log

A channel to select from git log entries

Requirements: git

Code: git-log.toml

[metadata]
name = "git-log"
description = "A channel to select from git log entries"
requirements = [ "git",]

[source]
command = "git log --oneline --date=short --pretty=\"format:%h %s %an %cd\" \"$@\""
output = "{split: :0}"

[preview]
command = "git show -p --stat --pretty=fuller --color=always {0}"

git-reflog

A channel to select from git reflog entries

Requirements: git

Code: git-reflog.toml

[metadata]
name = "git-reflog"
description = "A channel to select from git reflog entries"
requirements = [ "git",]

[source]
command = "git reflog"
output = "{split: :0}"

[preview]
command = "git show -p --stat --pretty=fuller --color=always {0}"

git-repos

A channel to select from git repositories on your local machine.

This channel uses fd to find directories that contain a .git subdirectory, and then allows you to preview the git log of the selected repository.

Requirements: fd, git

Code: git-repos.toml

[metadata]
name = "git-repos"
requirements = [ "fd", "git",]
description = "A channel to select from git repositories on your local machine.\n\nThis channel uses `fd` to find directories that contain a `.git` subdirectory, and then allows you to preview the git log of the selected repository.\n"

[source]
command = "fd -g .git -HL -t d -d 10 --prune ~ -E 'Library' -E 'Application Support' --exec dirname {}"
display = "{split:/:-1}"

[preview]
command = "cd {}; git log -n 200 --pretty=medium --all --graph --color"

text

A channel to find and select text from files

Requirements: rg, bat

Code: text.toml

[metadata]
name = "text"
description = "A channel to find and select text from files"
requirements = [ "rg", "bat",]

[source]
command = "rg . --no-heading --line-number"
display = "[{split:\\::..2}]\t{split:\\::2}"
output = "{split:\\::..2}"

[preview]
command = "bat -n --color=always {split:\\::0}"
offset = "{split:\\::1}"

[preview.env]
BAT_THEME = "ansi"

[ui.preview_panel]
header = "{split:\\::..2}"

zsh-history

A channel to select from your zsh history

Requirements: zsh

Code: zsh-history.toml

[metadata]
name = "zsh-history"
description = "A channel to select from your zsh history"
requirements = [ "zsh",]

[source]
command = "sed '1!G;h;$!d' ${HISTFILE:-${HOME}/.zsh_history}"
display = "{split:;:1..}"
output = "{split:;:1..}"

alias
bash-history
dirs
docker-images
dotfiles
env
files
fish-history
git-branch
git-diff
git-log
git-reflog
git-repos
text
zsh-history

+ + \ No newline at end of file diff --git a/docs/Users/community-channels-windows/index.html b/docs/Users/community-channels-windows/index.html new file mode 100644 index 0000000..45c819c --- /dev/null +++ b/docs/Users/community-channels-windows/index.html @@ -0,0 +1,95 @@ + + + + + +🍿 Community Channels (windows) | Television + + + + + +

🍿 Community Channels (windows)

alias

A channel to select from shell aliases

Requirements: None

Code: alias.toml

[metadata]
name = "alias"
description = "A channel to select from shell aliases"

[source]
command = "Get-Alias | %{ \"{0,-10} = {1,-10}\" -f $_.Name,$_.Definition }"
output = "{split:=:0|trim}"

dirs

A channel to select from directories

Requirements: fd

Code: dirs.toml

[metadata]
name = "dirs"
description = "A channel to select from directories"
requirements = [ "fd",]

[source]
command = [ "fd -t d", "fd -t d --hidden",]

[preview]
command = "ls -l {}"

[keybindings]
shortcut = "f2"

docker-images

A channel to select from Docker images

Requirements: docker, jq

Code: docker-images.toml

[metadata]
name = "docker-images"
description = "A channel to select from Docker images"
requirements = [ "docker", "jq",]

[source]
command = "docker images --format '{{.Repository}}:{{.Tag}} {{.ID}}'"
output = "{split: :-1}"

[preview]
command = "docker image inspect {split: :-1} | jq -C"

dotfiles

A channel to select from your user's dotfiles

Requirements: fd, bat

Code: dotfiles.toml

[metadata]
name = "dotfiles"
description = "A channel to select from your user's dotfiles"
requirements = [ "fd", "bat",]

[source]
command = "fd -t f . \"$env:USERPROFILE\\AppData\\Roaming\\\""

[preview]
command = "bat -n --color=always {}"

env

A channel to select from environment variables

Requirements: None

Code: env.toml

[metadata]
name = "env"
description = "A channel to select from environment variables"

[source]
command = "Get-ChildItem Env: | %{ \"{0,-30} = {1,-30}\" -f $_.Name,$_.Value }"
output = "{split:=:1..}"

[preview]
command = "echo '{split:=:1..}'"

[ui]
layout = "portrait"

[keybindings]
shortcut = "f3"

[ui.preview_panel]
size = 20
header = "{split:=:0|trim}"

files

A channel to select files and directories

Requirements: fd, bat

Code: files.toml

[metadata]
name = "files"
description = "A channel to select files and directories"
requirements = [ "fd", "bat",]

[source]
command = [ "fd -t f", "fd -t f -H",]

[preview]
command = "bat -n --color=always {}"

[keybindings]
shortcut = "f1"

[preview.env]
BAT_THEME = "ansi"

git-branch

A channel to select from git branches

Requirements: git

Code: git-branch.toml

[metadata]
name = "git-branch"
description = "A channel to select from git branches"
requirements = [ "git",]

[source]
command = "git --no-pager branch --all --format=\"%(refname:short)\""
output = "{split: :0}"

[preview]
command = "git show -p --stat --pretty=fuller --color=always {0}"

git-diff

A channel to select files from git diff commands

Requirements: git

Code: git-diff.toml

[metadata]
name = "git-diff"
description = "A channel to select files from git diff commands"
requirements = [ "git",]

[source]
command = "git diff --name-only HEAD"

[preview]
command = "git diff HEAD --color=always -- {}"

git-log

A channel to select from git log entries

Requirements: git

Code: git-log.toml

[metadata]
name = "git-log"
description = "A channel to select from git log entries"
requirements = [ "git",]

[source]
command = "git log --oneline --date=short --pretty=\"format:%h %s %an %cd\""
output = "{split: :0}"

[preview]
command = "git show -p --stat --pretty=fuller --color=always {0}"

git-reflog

A channel to select from git reflog entries

Requirements: git

Code: git-reflog.toml

[metadata]
name = "git-reflog"
description = "A channel to select from git reflog entries"
requirements = [ "git",]

[source]
command = "git reflog"
output = "{split: :0}"

[preview]
command = "git show -p --stat --pretty=fuller --color=always {0}"

git-repos

A channel to select from git repositories on your local machine.

This channel uses fd to find directories that contain a .git subdirectory, and then allows you to preview the git log of the selected repository.

Requirements: fd, git

Code: git-repos.toml

[metadata]
name = "git-repos"
requirements = [ "fd", "git",]
description = "A channel to select from git repositories on your local machine.\n\nThis channel uses `fd` to find directories that contain a `.git` subdirectory, and then allows you to preview the git log of the selected repository.\n"

[source]
command = "fd -g .git -HL -t d -d 10 --prune 'C:\\Users' --exec dirname '{}'"
display = "{split:\\\\:-1}"

[preview]
command = "cd '{}'; git log -n 200 --pretty=medium --all --graph --color"

pwsh-history

A channel to select from your powershell history

Requirements: None

Code: pwsh-history.toml

[metadata]
name = "pwsh-history"
description = "A channel to select from your powershell history"

[source]
command = "Get-Content (Get-PSReadLineOption).HistorySavePath | Select-Object -Last 500"

text

A channel to find and select text from files

Requirements: rg, bat

Code: text.toml

[metadata]
name = "text"
description = "A channel to find and select text from files"
requirements = [ "rg", "bat",]

[source]
command = "rg . --no-heading --line-number"
display = "[{split:\\::..2}]\t{split:\\::2}"
output = "{split:\\::..2}"

[preview]
command = "bat -n --color=always {split:\\::0}"
offset = "{split:\\::1}"

[preview.env]
BAT_THEME = "ansi"

[ui.preview_panel]
header = "{split:\\::..2}"

alias
dirs
docker-images
dotfiles
env
files
git-branch
git-diff
git-log
git-reflog
git-repos
pwsh-history
text

+ + \ No newline at end of file diff --git a/docs/Users/configuration/index.html b/docs/Users/configuration/index.html new file mode 100644 index 0000000..63250fb --- /dev/null +++ b/docs/Users/configuration/index.html @@ -0,0 +1,25 @@ + + + + + +Configuration | Television + + + + + +

Configuration

Default configuration reference

TV's configuration is done through a single TOML file, which allows you to customize the behavior and appearance of the +application.

Default configuration: config.toml

User configuration

Locations where television expects the user configuration file to be located for each platform:

Platform	Value
Linux	`$HOME/.config/television/config.toml`
macOS	`$HOME/.config/television/config.toml`
Windows	`%LocalAppData%\television\config`

Or, if you'd rather use the XDG Base Directory Specification, tv will look for the configuration file in +$XDG_CONFIG_HOME/television/config.toml if the environment variable is set.

Default configuration reference
User configuration

+ + \ No newline at end of file diff --git a/docs/Users/installation/index.html b/docs/Users/installation/index.html new file mode 100644 index 0000000..b481f55 --- /dev/null +++ b/docs/Users/installation/index.html @@ -0,0 +1,51 @@ + + + + + +Installation | Television + + + + + +

Installation

📦 Nix

Television is available on nixpkgs

nix run nixpkgs#television

📦 Homebrew

brew install television

📦 Scoop

scoop bucket add extras
scoop install television

📦 WinGet

winget install --exact --id alexpasmantier.television

📦 Arch Linux

pacman -S television

📦 Chimera Linux

apk add chimera-repo-user
apk add television

📦 Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.)

VER=`curl -s "https://api.github.com/repos/alexpasmantier/television/releases/latest" | grep '"tag_name":' | sed -E 's/.*"tag_name": "([^"]+)".*/\1/'`
curl -LO https://github.com/alexpasmantier/television/releases/download/$VER/tv-$VER-x86_64-unknown-linux-musl.deb
echo $VER
sudo dpkg -i tv-$VER-x86_64-unknown-linux-musl.deb

📦 Conda-forge (cross-platform)

pixi global install television

📦 Pre-compiled Binary

From the latest release page:

Download the latest release asset for your platform (e.g. tv-vX.X.X-linux-x86_64.tar.gz if you're on a linux x86 machine)
Unpack and copy to the relevant location on your system (e.g. /usr/local/bin on macos and linux for a global installation)

📦 Crates.io

Setup the latest stable Rust toolchain via rustup:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup update

Install television:

cargo install --locked television

📦 Building from source

If you want to benefit from the latest updates on main, clone the repo and build from source by running:

git clone git@github.com:alexpasmantier/television.git && cd television
just build release

You can then alias tv to the produced binary:

alias tv=$TELEVISION_DIR/target/release/tv

📦 Repology

📦 Nix
📦 Homebrew
📦 Scoop
📦 WinGet
📦 Arch Linux
📦 Chimera Linux
📦 Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.)
📦 Conda-forge (cross-platform)
📦 Pre-compiled Binary
📦 Crates.io
📦 Building from source
📦 Repology

+ + \ No newline at end of file diff --git a/docs/Users/keybindings/index.html b/docs/Users/keybindings/index.html new file mode 100644 index 0000000..1547de3 --- /dev/null +++ b/docs/Users/keybindings/index.html @@ -0,0 +1,28 @@ + + + + + +Keybindings | Television + + + + + +

Keybindings

Default Keybindings

Default keybindings are as follows:

Key	Description
`↑` / `↓` or `Ctrl` + `p` / `n` or `Ctrl` + `k` / `j`	Navigate through the list of entries
`Ctrl` + `u` / `d`	Scroll the preview pane up / down
`Enter`	Select the current entry
`Tab` / `BackTab`	Toggle selection and move to next / previous entry
`Ctrl` + `y`	Copy the selected entry to the clipboard
`Ctrl` + `r`	Toggle remote control mode
`Ctrl` + `s`	Toggle send to channel mode
`Ctrl` + `g`	Toggle the help panel
`Ctrl` + `o`	Toggle the preview panel
`Esc`	Quit the application

These keybindings are all configurable via tv's configuration file (see Configuration).

Keybindings Guide

Following this are some configuration presets you can use for your bindings. Most of these will probably match an existing program.

+
[!NOTE] +This list is maintained by the community, so feel free to contribute your own ideas too! 😊
+

Emacs

# Television already has some pretty Emacsy keybinds.
# This just makes them "Emacsier".
[keybindings]
scroll_preview_half_page_down = "alt-v"
scroll_preview_half_page_up = "ctrl-v"
toggle_remote_control = "alt-x" # Like execute-extended-command
toggle_help = "ctrl-h"

Default Keybindings
Emacs

+ + \ No newline at end of file diff --git a/docs/Users/quickstart/index.html b/docs/Users/quickstart/index.html new file mode 100644 index 0000000..5904199 --- /dev/null +++ b/docs/Users/quickstart/index.html @@ -0,0 +1,24 @@ + + + + + +Quickstart | Television + + + + + +

Quickstart

Create a channel: ~/.config/television/cable/files.toml

[metadata]
name = "files"
description = "A channel to select files and directories"
requirements = ["fd", "bat"]

[source]
command = "fd -t f"

[preview]
command = "bat -n --color=always '{}'"
env = { BAT_THEME = "Catppuccin Mocha" }

[ui]
preview_panel = { "size" = 70, "scrollbar" = true }

[keybindings]
shortcut = "f1"

Start searching:

tv files

tv files

Switch channels using the remote control and pick from a large choice of community-maintained channels:

tv remote

See the channels docs for more info on how to set these up.

+ + \ No newline at end of file diff --git a/docs/Users/search-patterns/index.html b/docs/Users/search-patterns/index.html new file mode 100644 index 0000000..2ceebc1 --- /dev/null +++ b/docs/Users/search-patterns/index.html @@ -0,0 +1,26 @@ + + + + + +Search Patterns | Television + + + + + +

Search Patterns

Tv uses a fuzzy matching algorithm to filter its list of entries. Its behavior depends on the input pattern you provide.

Matcher	Pattern
Fuzzy	`foo`
Substring	`'foo` / `!foo` to negate
Prefix	`^foo` / `!^foo` to negate
Suffix	`foo$` / `!foo$` to negate
Exact	`^foo$` / `!^foo$` to negate

These patterns (and matchers) can be associated (as "AND") to express complex search queries such as:

car 'bike !^car !bike$

which translates to:

anything that:
- fuzzy matches `car`
- contains the exact substring `bike`
- does not start with `car`
- does not end with `bike`

And will produce the following results:

haystack	match	explanation
the car drove past the bike	❌	ends with bike
car, bike or bus?	❌	starts with car
the black motorbike flew past the tourists	✅
the motorbike flew past the tourists	❌	doesn't contain 'car'

For more information on the matcher behavior, see the +nucleo-matcher documentation.

+ + \ No newline at end of file diff --git a/docs/Users/shell-integration/index.html b/docs/Users/shell-integration/index.html new file mode 100644 index 0000000..167b977 --- /dev/null +++ b/docs/Users/shell-integration/index.html @@ -0,0 +1,78 @@ + + + + + +Shell Integration | Television + + + + + +

Shell Integration

Television can integrate with your shell to provide smart autocompletion based on the commands you start typing.

tv-shell-integration

Keybindings

Ctrl-R: shell history
Ctrl-T: smart autocompletion for the current prompt command

Enabling shell integration

Zsh

To enable shell integration for zsh, run:

echo 'eval "$(tv init zsh)"' >> ~/.zshrc

And then restart your shell or run:

source ~/.zshrc

Bash

To enable shell integration for bash, run:

echo 'eval "$(tv init bash)"' >> ~/.bashrc

And then restart your shell or run:

source ~/.bashrc

Fish

To enable shell integration for fish, add:

tv init fish | source

to your is-interactive block in your ~/.config/fish/config.fish file and then restart your shell.

Nushell

To enable shell integration for nu, add this to your ~/.config/nushell/config.nu file:

mkdir ($nu.data-dir | path join "vendor/autoload")
tv init nu | save -f ($nu.data-dir | path join "vendor/autoload/tv.nu")

Configuring autocompletion

Shell integration works by setting a dedicated shell keybinding that launches tv with the current prompt buffer so that tv may guess which channel (builtin or cable) is the most appropriate.

Which channel gets effectively chosen for different commands can be tweaked in the shell_integration section of the configuration file:

[shell_integration.channel_triggers]
"env" = ["export", "unset"]
"dirs" = ["cd", "ls", "rmdir"]
"files" = ["mv", "cp", "vim"]

Each key is a channel name and each value is a set of commands that should trigger that channel.

Example: say you want the following prompts to trigger the following channels when pressing CTRL-T`:

git checkout should trigger the git-branches channel
ls should trigger the dirs channel
cat and nano should trigger the files channel

You would add the following to your configuration file:

[shell_integration.channel_triggers]
"git-branches" = ["git checkout"]
"dirs" = ["ls"]
"files" = ["cat", "nano"]

Customizing shell integration scripts

Setting up the files

To customize the default behavior of the shell integration scripts you can save them locally and source that file instead:

Run the following command to make sure the destination directory exists, you can also store them wherever you like

mkdir -p ~/.config/television/shell

Note: Remember to remove the line added in Enabling Shell Integration to avoid sourcing the file twice.

Zsh

tv init zsh > ~/.config/television/shell/integration.zsh
echo 'source $HOME/.config/television/shell/integration.zsh' >> ~/.zshrc

Bash

tv init bash > ~/.config/television/shell/integration.bash
echo 'source $HOME/.config/television/shell/integration.bash' >> ~/.bashrc

Fish

tv init fish > ~/.config/television/shell/integration.fish

Then add to your is-interactive block in your ~/.config/fish/config.fish file.

source $HOME/.config/television/shell/integration.fish

For all shells you'll have to restart it (or similar) to integrate the changes.

Recipes

Automatically executing selection

Edit the ~/.config/television/shell/integration.zsh file and add the following:

_tv_search() {
    emulate -L zsh
    zle -I

    local current_prompt
    current_prompt=$LBUFFER

    local output

    output=$(tv --autocomplete-prompt "$current_prompt" $*)

    zle reset-prompt

    if [[ -n $output ]]; then
        RBUFFER=""
        LBUFFER=$current_prompt$output

        # uncomment this to automatically accept the line
        # (i.e. run the command without having to press enter twice)
        # zle accept-line
    fi
}


zle -N tv-search _tv_search


bindkey '^T' tv-search

Note: Uncommenting zle accept-line below will automatically execute the command when accepting a suggestion

Open history channel with the most up to date version of the history file

Edit the ~/.config/television/shell/integration.bash file and replace the tv_shell_history function with the following (or rename to keep the default implementation):

function tv_shell_history() {
  local current_prompt="${READLINE_LINE:0:$READLINE_POINT}"

  local output=$(history -n && history -a && tv bash-history --input "$current_prompt")

  if [[ -n $output ]]; then
    READLINE_LINE=$output
    READLINE_POINT=${#READLINE_LINE}
  fi
}
# history -n  to read the current file, in case other sessions wrote some commands
# history -a  to commit the current one

WARNING: committing the current history to file could have unintended consequences as a default, for example if the user was planning to run history -c to clear the current session (perhaps some commands have sensitive information)

Keybindings
Enabling shell integration
Configuring autocompletion
Customizing shell integration scripts
- Setting up the files
- Recipes

+ + \ No newline at end of file diff --git a/docs/Users/showcase/index.html b/docs/Users/showcase/index.html new file mode 100644 index 0000000..a2024f3 --- /dev/null +++ b/docs/Users/showcase/index.html @@ -0,0 +1,70 @@ + + + + + +Showcase | Television + + + + + +

Showcase

This section is meant as a community-driven list of user workflows and ways to use television in different contexts to inspire others.

⭐ VSCode extension

https://marketplace.visualstudio.com/items?itemName=alexpasmantier.television

⭐ Zed Editor File Finder

This is a drop-in file editor setup for the zed editor leveraging television, a task, and keybinding.

tv-zed-editor-compressed

Install television
Add a task for a file finder (zed: open tasks command)

tasks.json

{
  "label": "File Finder",
  "command": "zed $(tv files)",
  "hide": "always",
  "allow_concurrent_runs": true,
  "use_new_terminal": true
},

Add keybinding to open file finder in center terminal (zed: open keymap command)

keymap.json

[
  {
    "bindings": {
      // replace file_finder::Toggle
      "cmd-p": [
        "task::Spawn",
        { "task_name": "File Finder", "reveal_target": "center" },
      ],
    },
  },
]

This should result in an interaction similar to the GIF above.

⭐ Vim/Neovim plugin

credit: https://github.com/prabirshrestha/tv.vim

tv.vim

⭐ Zed Editor Live Grep

This is a drop-in project search setup for the zed editor with similar setup to the file finder.

https://github.com/user-attachments/assets/5afb94af-f10a-4cac-9f51-0aa97b771bf0

Install television
Add a task for a file finder (zed: open tasks command)

tasks.json

{
    "label": "Live Grep",
    "command": "zed $(tv text)",
    "hide": "always",
    "allow_concurrent_runs": true,
    "use_new_terminal": true,
},

Add keybinding to open file finder in center terminal (zed: open keymap command)

keymap.json

{
  "bindings": {
    "space f w": [
      "task::Spawn",
      { "task_name": "Live Grep", "reveal_target": "center" }
    ]
  }
}

You can replace space f w with your keybinding

Improve performance

If there's a delay before the Live Grep window lauches you can optimize this by spawning it in a different shell, eg. bash or sh.| +In the example below zed will use sh to spawn the process:

tasks.json

  {
    "label": "Live Grep",
    "command": "zed $(tv text)",
    "hide": "always",
    "allow_concurrent_runs": true,
    "use_new_terminal": true,
    "shell": {
      "program": "sh"
    }
  },

If you neeed further optimalization you can add commandline args like --noediting, --norc, --noprofile to the shell process:

tasks.json

    "shell": {
      "with_arguments": {
        "program": "sh",
        "args": ["--noediting", "--norc", "--noprofile"]
      }
    }

tasks.json

    "shell": {
      "with_arguments": {
        "program": "bash",
        "args": ["--norc", "--noprofile"]
      }
    }

+
Note that you need to have tv in your $PATH
+

+
This optimizations can also be applied to file finder.
+

Huge thanks to eddiebergman and thomdabrowski for these optimizations, original thread

⭐ VSCode extension
⭐ Zed Editor File Finder
⭐ Vim/Neovim plugin
⭐ Zed Editor Live Grep

+ + \ No newline at end of file diff --git a/docs/Users/terminal_emulators/index.html b/docs/Users/terminal_emulators/index.html new file mode 100644 index 0000000..de213fb --- /dev/null +++ b/docs/Users/terminal_emulators/index.html @@ -0,0 +1,19 @@ + + + + + +Terminal Emulators | Television + + + + + +

Terminal Emulators

Here is a list of terminal emulators that have currently been tested with television and their compatibility status.

Terminal Emulator	Tested Platforms	Compatibility
Alacritty	macOS, Linux	✅
Kitty	macOS, Linux	✅
iTerm2	macOS	✅
Ghostty	macOS, Linux, Windows	✅
Wezterm	macOS, Linux, Windows	✅
macOS Terminal	macOS	functional but coloring issues
Konsole	Linux	✅
Terminator	Linux	✅
Xterm	Linux	✅
Cmder	Windows	✅
Foot	Linux	✅
Rio	macOS, Linux, Windows	✅
Warp	macOS	✅
Hyper	macOS	✅

If you're able to test the application with a configuration not yet listed above, we'd love to hear from your experience 🙏

+ + \ No newline at end of file diff --git a/docs/Users/themes/index.html b/docs/Users/themes/index.html new file mode 100644 index 0000000..f179d8b --- /dev/null +++ b/docs/Users/themes/index.html @@ -0,0 +1,22 @@ + + + + + +Themes | Television + + + + + +

Themes

Builtin themes are available in the themes directory. Feel free to experiment and maybe even contribute your own!

catppuccin	gruvbox-dark
solarized-dark	nord

You may create your own custom themes by adding them to the themes directory in your configuration folder and then referring to them by file name (without the extension) in the configuration file.

config_location/
├── themes/
│   └── my_theme.toml
└── config.toml

my_theme.toml

# general
background = '#1e1e2e'
border_fg = '#6c7086'
text_fg = '#cdd6f4'
dimmed_text_fg = '#6c7086'
# input
input_text_fg = '#f38ba8'
result_count_fg = '#f38ba8'
# results
result_name_fg = '#89b4fa'
result_line_number_fg = '#f9e2af'
result_value_fg = '#b4befe'
selection_fg = '#a6e3a1'
selection_bg = '#313244'
match_fg = '#f38ba8'
# preview
preview_title_fg = '#fab387'
# modes
channel_mode_fg = '#1e1e2e'
channel_mode_bg = '#f5c2e7'
remote_control_mode_fg = '#1e1e2e'
remote_control_mode_bg = '#a6e3a1'
send_to_channel_mode_fg = '#89dceb'

+ + \ No newline at end of file diff --git a/fonts/Doto.ttf b/fonts/Doto.ttf new file mode 100644 index 0000000..5b4cf7d Binary files /dev/null and b/fonts/Doto.ttf differ diff --git a/fonts/NotoSans-Italic.ttf b/fonts/NotoSans-Italic.ttf new file mode 100644 index 0000000..6245ba0 Binary files /dev/null and b/fonts/NotoSans-Italic.ttf differ diff --git a/fonts/NotoSans.ttf b/fonts/NotoSans.ttf new file mode 100644 index 0000000..9530d84 Binary files /dev/null and b/fonts/NotoSans.ttf differ diff --git a/fonts/UbuntuMono-Bold.ttf b/fonts/UbuntuMono-Bold.ttf new file mode 100644 index 0000000..01ad81b Binary files /dev/null and b/fonts/UbuntuMono-Bold.ttf differ diff --git a/fonts/UbuntuMono-BoldItalic.ttf b/fonts/UbuntuMono-BoldItalic.ttf new file mode 100644 index 0000000..731884e Binary files /dev/null and b/fonts/UbuntuMono-BoldItalic.ttf differ diff --git a/fonts/UbuntuMono-Italic.ttf b/fonts/UbuntuMono-Italic.ttf new file mode 100644 index 0000000..b89338d Binary files /dev/null and b/fonts/UbuntuMono-Italic.ttf differ diff --git a/fonts/UbuntuMono-Regular.ttf b/fonts/UbuntuMono-Regular.ttf new file mode 100644 index 0000000..4977028 Binary files /dev/null and b/fonts/UbuntuMono-Regular.ttf differ diff --git a/img/favicon.ico b/img/favicon.ico new file mode 100644 index 0000000..95cf6f9 Binary files /dev/null and b/img/favicon.ico differ diff --git a/img/inspired_icon.svg b/img/inspired_icon.svg new file mode 100644 index 0000000..bea4964 --- /dev/null +++ b/img/inspired_icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/img/integrate_icon.svg b/img/integrate_icon.svg new file mode 100644 index 0000000..d3a147b --- /dev/null +++ b/img/integrate_icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/img/logo.svg b/img/logo.svg new file mode 100644 index 0000000..37140c9 --- /dev/null +++ b/img/logo.svg @@ -0,0 +1,10 @@ + diff --git a/img/logo_dark.svg b/img/logo_dark.svg new file mode 100644 index 0000000..3469b60 --- /dev/null +++ b/img/logo_dark.svg @@ -0,0 +1,10 @@ + diff --git a/img/tv-bg.png b/img/tv-bg.png new file mode 100644 index 0000000..4c363e6 Binary files /dev/null and b/img/tv-bg.png differ diff --git a/img/tv-icon-150.png b/img/tv-icon-150.png new file mode 100644 index 0000000..13aa18e Binary files /dev/null and b/img/tv-icon-150.png differ diff --git a/img/tv-icon-80.png b/img/tv-icon-80.png new file mode 100644 index 0000000..013f01f Binary files /dev/null and b/img/tv-icon-80.png differ diff --git a/img/tv-icon-huge.png b/img/tv-icon-huge.png new file mode 100644 index 0000000..9ee32a6 Binary files /dev/null and b/img/tv-icon-huge.png differ diff --git a/img/tv-social.png b/img/tv-social.png new file mode 100644 index 0000000..708ca5d Binary files /dev/null and b/img/tv-social.png differ diff --git a/img/tv-transparent.png b/img/tv-transparent.png new file mode 100644 index 0000000..8a5d10e Binary files /dev/null and b/img/tv-transparent.png differ diff --git a/index.html b/index.html new file mode 100644 index 0000000..0d0f61a --- /dev/null +++ b/index.html @@ -0,0 +1,16 @@ + + + + + +Television + + + + + +

Television

The cross-platform, fast and extensible fuzzy finder.

Television is a cross-platform, fast and extensible fuzzy finder for the terminal.

It integrates with your shell and lets you quickly search through any kind of data source (files, git repositories, environment variables, docker images, you name it) using a fuzzy matching algorithm and is designed to be extensible.

It is inspired by the neovim telescope plugin and leverages tokio and the nucleo matcher used by helix to ensure optimal performance.

Getting Started

+ + \ No newline at end of file diff --git a/markdown-page/index.html b/markdown-page/index.html new file mode 100644 index 0000000..e35fb37 --- /dev/null +++ b/markdown-page/index.html @@ -0,0 +1,17 @@ + + + + + +Markdown page example | Television + + + + + +

Markdown page example

You don't need React to write simple standalone pages.

+ + \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..9ef0fab --- /dev/null +++ b/sitemap.xml @@ -0,0 +1 @@ +https://alexpasmantier.github.io/television/markdown-pageweekly0.5https://alexpasmantier.github.io/television/docs/Developers/ARCHITECTUREweekly0.5https://alexpasmantier.github.io/television/docs/Developers/patch-notesweekly0.5https://alexpasmantier.github.io/television/docs/Developers/ui-featuresweekly0.5https://alexpasmantier.github.io/television/docs/Users/channelsweekly0.5https://alexpasmantier.github.io/television/docs/Users/cliweekly0.5https://alexpasmantier.github.io/television/docs/Users/community-channels-unixweekly0.5https://alexpasmantier.github.io/television/docs/Users/community-channels-windowsweekly0.5https://alexpasmantier.github.io/television/docs/Users/configurationweekly0.5https://alexpasmantier.github.io/television/docs/Users/installationweekly0.5https://alexpasmantier.github.io/television/docs/Users/keybindingsweekly0.5https://alexpasmantier.github.io/television/docs/Users/quickstartweekly0.5https://alexpasmantier.github.io/television/docs/Users/search-patternsweekly0.5https://alexpasmantier.github.io/television/docs/Users/shell-integrationweekly0.5https://alexpasmantier.github.io/television/docs/Users/showcaseweekly0.5https://alexpasmantier.github.io/television/docs/Users/terminal_emulatorsweekly0.5https://alexpasmantier.github.io/television/docs/Users/themesweekly0.5https://alexpasmantier.github.io/television/weekly0.5 \ No newline at end of file

Page Not Found

Overview​

High-Level Architecture​

How It Works​

1. Startup​

2. Runtime Event Flow​

Core Components​

Application Orchestrator (app.rs)​

Event System​

Event Loop (loops/event_loop.rs)​

Actions (action.rs)​

Television Core (television.rs)​

Channel System​

Channel Config (channels/prototypes/)​

Channel Runtime (channels/channel.rs)​

Rendering System​

Render Loop (loops/render_loop.rs)​

Drawing (draw.rs)​

Configuration System​

Preview System (previewer/)​

Watch Timer (loops/watch_timer.rs)​

Communication​

Data Flow​

Design Patterns​

1. Actor Model​

2. Command Pattern​

3. Observer Pattern​

4. Plugin Architecture​

Performance​

How to Extend​

Adding New Channels​

Custom Keybindings​

UI Themes​

Overview​

Architecture​

Context Diagram​

Feature Components​

Preview Panel​

Status Bar​

Help Panel​

Remote Control​

State Management​

Configuration System​

Configuration Formats​

Configuration Inheritance​

Default UI Feature States​

Feature State Persistence​

Examples​

Basic Feature Control​

Channel-Specific Configuration​

Runtime Feature Management​

Quick start​

Default location on your system​

Community-maintained channels​

Invocation​

Creating your own channels​

Templating syntax​

Channel specification​

high-level sections​

[metadata]​

[source]​

[preview]​

[ui]​

[keybindings]​

Table of Contents​

Overview​

Operating Modes​

Channel Mode​

Ad-hoc Mode​

Basic Usage​

Arguments​

Position 1: [CHANNEL]​

Position 2: [PATH]​

⚡ Smart Path Detection Logic​

Options​

🎯 Source and Data Options​

--source-command <STRING>​

--source-display <STRING>​

--source-output <STRING>​

👁️ Preview Options​

Overview

High-Level Architecture

How It Works

1. Startup

2. Runtime Event Flow

Core Components

Application Orchestrator (`app.rs`)

Event System

Event Loop (`loops/event_loop.rs`)

Actions (`action.rs`)

Television Core (`television.rs`)

Channel System

Channel Config (`channels/prototypes/`)

Channel Runtime (`channels/channel.rs`)

Rendering System

Render Loop (`loops/render_loop.rs`)

Drawing (`draw.rs`)

Configuration System

Preview System (`previewer/`)

Watch Timer (`loops/watch_timer.rs`)

Communication

Data Flow

Design Patterns

1. Actor Model

2. Command Pattern

3. Observer Pattern

4. Plugin Architecture

Performance

How to Extend

Adding New Channels

Custom Keybindings

UI Themes

Overview

Architecture

Context Diagram

Feature Components

Preview Panel

Status Bar

Help Panel

Remote Control

State Management

Configuration System

Configuration Formats

Configuration Inheritance

Default UI Feature States

Feature State Persistence

Examples

Basic Feature Control

Channel-Specific Configuration

Runtime Feature Management

Quick start

Default location on your system

Community-maintained channels

Invocation

Creating your own channels

Templating syntax

Channel specification

high-level sections

`[metadata]`

`[source]`

`[preview]`

`[ui]`

`[keybindings]`

Table of Contents

Overview

Operating Modes

Channel Mode

Ad-hoc Mode

Basic Usage

Arguments

Position 1: `[CHANNEL]`

Position 2: `[PATH]`

⚡ Smart Path Detection Logic

Options

🎯 Source and Data Options

`--source-command <STRING>`

`--source-display <STRING>`

`--source-output <STRING>`

👁️ Preview Options

`--no-preview`