Metadata-Version: 2.4
Name: birdeye
Version: 0.7.0
Summary: A terminal-based file tree navigator.
Author-email: Sander Teunissen <s.teunissen@gmail.com>
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.13
Requires-Dist: platformdirs>=4
Requires-Dist: pygit2>=1.19
Requires-Dist: textual>=0.79
Description-Content-Type: text/markdown

# birdeye

A terminal-based file tree navigator.

## Overview

birdeye is an interactive file tree viewer that allows you to navigate directory structures directly from your terminal.

## Features

- **Interactive Navigation**: Use arrow keys to move through the file tree
- **Expand/Collapse**: Toggle directories to show or hide their contents
- **Search**: press '/' to enter a search term and have matches auto expand and highlighted. 

## Installation

`pip install birdeye`

or better use `pipx` or `uv tool` and you'll have a birdeye command available in your prompt.

## Configuration

birdeye looks for configuration files in your system's config directory:

- **Linux**: `~/.config/birdeye/`
- **macOS**: `~/Library/Application Support/birdeye/`
- **Windows**: `%APPDATA%\birdeye\`

### File Openers

Create `opener.json` to customize which program opens each file type when you press Enter:

```json
{
  ".py": "code",
  ".toml": "code",
  ".md": "typora"
}
```

If the file doesn't exist, birdeye defaults to opening `.py` and `.toml` files with `code`, and all other files with `open`.

