## File: README.md

## About

Television is a fast, portable fuzzy finder for the terminal. It lets you search in real-time through any kind of data source such as files, text, git repositories, environment variables, docker containers, and more.

**[Read the documentation](https://alexpasmantier.github.io/television/)**

## Quick Start

```sh
tv              # Search files (default channel)
tv text         # Search file contents
tv git-repos    # Find git repositories
tv --help       # See all options
```

For a complete introduction, see the [Quickstart Guide](https://alexpasmantier.github.io/television/getting-started/quickstart).

## Installation

### Quick Install (Recommended)

```sh
curl -fsSL https://alexpasmantier.github.io/television/install.sh | bash
```

### Package Managers

| Platform       | Command                                                 |
| -------------- | ------------------------------------------------------- |
| **Arch Linux** | `pacman -S television`                                  |
| **Homebrew**   | `brew install television`                               |
| **Cargo**      | `cargo install television`                              |
| **Scoop**      | `scoop bucket add extras && scoop install television`   |
| **WinGet**     | `winget install --exact --id alexpasmantier.television` |
| **Nix**        | `nix run nixpkgs#television`                            |

For more installation options, see [Installation](https://alexpasmantier.github.io/television/getting-started/installation).

## Custom Channels

Create custom channels for any workflow. Here's an example TLDR channel:

```toml
# ~/.config/television/cable/tldr.toml
[metadata]
name = "tldr"
description = "Browse TLDR pages"

[source]
command = "tldr --list"

[preview]
command = "tldr '{}'"

[keybindings]
ctrl-e = "actions:open"

[actions.open]
command = "tldr '{}'"
mode = "execute"
```

Learn more about [creating channels](https://alexpasmantier.github.io/television/getting-started/first-channel).

## Shell Integration

Enable smart autocomplete (<kbd>Ctrl</kbd>+<kbd>T</kbd>) and history search (<kbd>Ctrl</kbd>+<kbd>R</kbd>):

```sh
# Zsh
echo 'eval "$(tv init zsh)"' >> ~/.zshrc

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

See [Shell Integration](https://alexpasmantier.github.io/television/user-guide/shell-integration) for more shells.

## Editor Integration

- **Neovim**: [tv.nvim](https://github.com/alexpasmantier/tv.nvim)
- **Vim**: [tv.vim](https://github.com/prabirshrestha/tv.vim)
- **VSCode**: [Television extension](https://marketplace.visualstudio.com/items?itemName=alexpasmantier.television)
- **Zed**: [Telescope-style setup](https://zed.dev/blog/hidden-gems-part-2#emulate-vims-telescope-via-television)
- **JetBrains IDEs**: [Television plugin](https://plugins.jetbrains.com/plugin/31448-television)

## Documentation

- [Getting Started](https://alexpasmantier.github.io/television/getting-started/quickstart)
- [User Guide](https://alexpasmantier.github.io/television/user-guide/channels)
- [Tips and Tricks](https://alexpasmantier.github.io/television/advanced/tips-and-tricks)
- [Reference](https://alexpasmantier.github.io/television/reference/cli)

## Credits

- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
- [nucleo](https://github.com/helix-editor/nucleo)
- [ratatui](https://github.com/ratatui/ratatui)

<a href="https://github.com/alexpasmantier/television/graphs/contributors">
  
</a>

---

## File: docs/intro.md

---
sidebar_position: 0
slug: /
title: Television
---

# Television

A fast, portable and hackable fuzzy finder for the terminal.



## Quick Install

```bash
curl -sSL https://raw.githubusercontent.com/alexpasmantier/television/refs/heads/main/install.sh | sh
```

Or see [Installation](./getting-started/installation) for other methods.

## What is Television?

Television is a fuzzy finder that lets you search through any kind of data in real-time. It comes with built-in channels for common tasks like finding files, searching git repositories, browsing environment variables, and more.

You can also create your own custom channels to search through any data source you need.

## Getting Started

New to Television? Start here:

- [Installation](./getting-started/installation) - Install Television on your system
- [Quickstart](./getting-started/quickstart) - Learn the basics in 5 minutes
- [Your First Channel](./getting-started/first-channel) - Create a custom channel

## Documentation

- **[User Guide](./user-guide/channels)** - Learn about channels, configuration, keybindings, and more
- **[Advanced](./advanced/template-system)** - Deep dive into templates, tips and tricks, and troubleshooting
- **[Reference](./reference/cli)** - Complete CLI, actions, and configuration reference
- **[Community](./community/channels-unix)** - Community channels and contributions
- **[Developers](./developers/contributing)** - Contributing guidelines and architecture