fileview 0.4.2

# FileView (fv)

[![Crates.io](https://img.shields.io/crates/v/fileview.svg)](https://crates.io/crates/fileview)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A minimal, VSCode-style file tree TUI for modern terminal emulators.

English | [日本語](README_ja.md)

## Features

- Fast file tree navigation with vim-like keybindings
- **Git integration** - color-coded file status and branch display
- Multi-select support for batch operations
- **Preview panel** with support for:
  - Text files (syntax highlighting by extension)
  - Images (half-block rendering)
  - Directories (file count, size statistics)
  - Binary files (hex dump view)
- Copy/cut/paste with internal clipboard
- System clipboard integration (path/filename copy)
- Pick mode for external tool integration
- Callback execution on file selection
- Hidden files toggle
- Mouse support (click, double-click, scroll)

## Git Status Colors

When inside a git repository, files are color-coded by their status:

| Color | Status |
|-------|--------|
| Yellow | Modified |
| Green | Added / Untracked |
| Red | Deleted |
| Cyan | Renamed |
| Gray | Ignored |
| Magenta | Conflict |

The current branch name is displayed in the status bar.

## Installation

### From crates.io (Recommended)

```bash
cargo install fileview
```

### From source

```bash
git clone https://github.com/Hiro-Chiba/fileview.git
cd fileview
cargo install --path .
```

### Requirements

- Rust 1.70+
- A terminal with true color support (recommended: Ghostty, iTerm2, Alacritty)

## Usage

```bash
# Open current directory
fv

# Open specific directory
fv /path/to/directory

# Pick mode (output selected path to stdout)
fv --pick

# Pick mode with JSON output
fv --pick --format json

# Execute command on selection
fv --on-select "code {path}"
```

## Keybindings

### Navigation

| Key | Action |
|-----|--------|
| `j` / `↓` | Move down |
| `k` / `↑` | Move up |
| `g` | Go to top |
| `G` | Go to bottom |

### Tree Operations

| Key | Action |
|-----|--------|
| `l` / `→` / `Tab` | Expand directory |
| `h` / `←` / `Backspace` | Collapse directory |
| `Enter` | Toggle expand/collapse |
| `H` | Collapse all |
| `L` | Expand all (depth limit: 5) |

### Selection

| Key | Action |
|-----|--------|
| `Space` | Toggle mark |
| `Esc` | Clear all marks |

### File Operations

| Key | Action |
|-----|--------|
| `a` | Create new file |
| `A` | Create new directory |
| `r` | Rename |
| `D` / `Delete` | Delete (with confirmation) |
| `y` | Copy to clipboard |
| `d` | Cut to clipboard |
| `p` | Paste |

### Search

| Key | Action |
|-----|--------|
| `/` | Start search |
| `n` | Next search result |

### Preview

| Key | Action |
|-----|--------|
| `P` | Toggle preview panel |
| `o` | Open fullscreen preview |

### Other

| Key | Action |
|-----|--------|
| `.` | Toggle hidden files |
| `R` / `F5` | Refresh |
| `c` | Copy path to system clipboard |
| `C` | Copy filename to system clipboard |
| `?` | Show help |
| `q` | Quit |

## CLI Options

| Option | Description |
|--------|-------------|
| `-p`, `--pick` | Pick mode: output selected path(s) to stdout |
| `-f`, `--format FMT` | Output format: `lines` (default), `null`, `json` |
| `--on-select CMD` | Run command when file is selected |
| `-h`, `--help` | Show help |
| `-V`, `--version` | Show version |

### Placeholders for `--on-select`

| Placeholder | Description |
|-------------|-------------|
| `{path}` | Full path |
| `{dir}` | Parent directory |
| `{name}` | Filename with extension |
| `{stem}` | Filename without extension |
| `{ext}` | Extension only |

### Examples

```bash
# Use as file picker for another tool
selected=$(fv --pick)
echo "Selected: $selected"

# Open selected file in editor
fv --on-select "vim {path}"

# Copy selected file path to clipboard (macOS)
fv --on-select "echo {path} | pbcopy"

# Multiple file selection with JSON output
fv --pick --format json
```

## License

MIT