<div align="center">
[<img src="./assets/television-title.png">](https://alexpasmantier.github.io/television/)
**A portable and hackable fuzzy finder for the terminal.**




[](https://discord.gg/hQBrzsJgUg)

</div>
## About
`Television` is a portable and hackable fuzzy finder for the terminal.
It lets you search in real time through any kind of data source (called "channels") such as:
- files and directories
- code
- notes
- processes
- git repositories
- environment variables
- docker containers
- ...and much more ([creating your own channels](https://alexpasmantier.github.io/television/docs/Users/channels/#creating-your-own-channels))
with support for previewing results, customizable actions and keybindings, and integration with your favorite
shell and editor.
## TL;DR
Create a new channel: _~/.config/television/cable/files.toml_
```toml
[metadata]
name = "files"
description = "A channel to search through files and directories"
requirements = ["fd", "bat"]
[source]
command = "fd -t f"
[preview]
command = "bat -n --color=always '{}'"
env = { BAT_THEME = "Catppuccin Mocha" }
```
Start searching:
```sh
tv files
```

Switch channels using the remote control and pick from a list of [community-maintained channels](https://alexpasmantier.github.io/television/docs/Users/community-channels-unix) or [create your own](https://alexpasmantier.github.io/television/docs/Users/channels/#creating-your-own-channels).

See the [channels docs](https://alexpasmantier.github.io/television/docs/Users/channels) for more info on how to set these up.
## Installation
1. [Automatically select the best installation method](#automatically-select-the-best-installation-method)
2. [Linux](#linux)
3. [MacOS](#macos)
4. [Windows](#windows)
5. [NetBSD](#netbsd)
6. [Cross-platform](#cross-platform)
7. [Precompiled binaries](#precompiled-binaries)
### Automatically select the best installation method
Running the following command will detect your OS and install `television` using the best available method:
```sh
### Linux
- [Arch Linux](https://archlinux.org/), [Manjaro](https://manjaro.org/), [EndeavourOS](https://endeavouros.com/), etc.:
```sh
pacman -S television
```
- [Debian](https://www.debian.org/), [Ubuntu](https://ubuntu.com/), [Linux Mint](https://linuxmint.com/),
[Pop!_OS](https://pop.system76.com/), etc.:
```sh
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
```
- [ChimeraOS](https://chimeraos.org/), [Alpine Linux](https://alpinelinux.org/):
```sh
apk add chimera-repo-user
apk add television
```
- [NixOS](https://nixos.org/) and other systems with [Nix package manager](https://nixos.org/download.html):
```sh
nix run nixpkgs#television
```
### MacOS
- [Homebrew](https://brew.sh/):
```sh
brew install television
```
### Windows
- [Scoop](https://scoop.sh/):
```sh
scoop bucket add extras
scoop install television
```
- [Winget](https://github.com/microsoft/winget-cli):
```sh
winget install --exact --id alexpasmantier.television
```
### NetBSD
- [pkgsrc](https://pkgsrc.se/textproc/television):
```sh
pkgin install television
```
### Cross-platform
- [Cargo](https://doc.rust-lang.org/cargo/):
```sh
cargo install television
```
- [Conda-forge](https://anaconda.org/conda-forge/television):
```sh
pixi global install television
```
### Precompiled binaries
Download the latest release from the [releases page](https://www.github.com/alexpasmantier/television/releases).
## Usage
```bash
tv
tv [channel]
my_program | tv
fd -t f . | tv --preview 'bat -n --color=always {}'
tv --source-command 'fd -t f .' --preview-command 'bat -n --color=always {}' --preview-size 70
```
> [!TIP]
> 🐚 _Television has **builtin shell integration**. More info [here](https://alexpasmantier.github.io/television/docs/Users/shell-integration)._
For more information, check out the [docs](https://alexpasmantier.github.io/television/).
## Using tv inside your favorite editor
- **Neovim**: [tv.nvim](https://github.com/alexpasmantier/tv.nvim) (lua)
- **Vim**: [tv.vim](https://github.com/prabirshrestha/tv.vim) (vimscript)
- **Zed**: [Easy Telescope-style file finder in Zed using television](https://github.com/zed-industries/zed/discussions/22581)
- **VSCode**: [using television as a file picker inside vscode](https://marketplace.visualstudio.com/items?itemName=alexpasmantier.television)
## Credits
This project was inspired by the **awesome** work done by the [telescope](https://github.com/nvim-telescope/telescope.nvim) neovim plugin.
It also leverages the great [helix](https://github.com/helix-editor/helix) editor's nucleo fuzzy matching library, the [tokio](https://github.com/tokio-rs/tokio) async runtime as well as the **formidable** [ratatui](https://github.com/ratatui/ratatui) library.
A special thanks to tv's contributors for their help and support:
<a href="https://github.com/alexpasmantier/television/graphs/contributors">
<img src="https://contrib.rocks/image?repo=alexpasmantier/television" />
</a>