Metadata-Version: 2.4
Name: birdeye
Version: 0.2.0
Summary: Add your description here
Author-email: Sander Teunissen <s.teunissen@gmail.com>
Requires-Python: >=3.13
Requires-Dist: prompt-toolkit>=3.0.51
Requires-Dist: pygit2>=1.19.0
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
- **Path Selection**: Select a file or directory path and have it printed to stdout. Use this for piping into other commands.

## Installation

`pip install birdeye`

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

## terminal usage

cd into a folder using birdeye. Put this bash function inside your `.bashrc` or `.zshrc` file.

```bash
# A function to visually change directories with birdeye
lcd() {
    local selected_dir
    selected_dir=$(birdeye)
    
    # If the user selected a path (and didn't just quit), `cd` into it.
    # Check if the selection is a directory.
    if [[ -n "$selected_dir" && -d "$selected_dir" ]]; then
        cd "$selected_dir"
    fi
}
```
