vtree-tree 2.2.0

A modern, interactive terminal-based file tree viewer with file panel support

vtree-tree

A modern, interactive terminal-based file tree viewer with file panel support.

Features

• 🌳 Interactive file tree - Navigate with mouse and keyboard
• 📁 Dual view modes - Toggle between inline files and separate file panel
• 📋 Clipboard integration - Copy paths with a single keystroke
• 🎨 Modern terminal theme - Clean, professional dark interface
• 👁️ Hidden file toggle - Show/hide dotfiles and system files
• 📊 File details - View sizes, modification dates, and file information
• ⚡ Smart filtering - Automatically ignores common development artifacts
• 🖱️ Mouse support - Full mouse navigation and selection
• ✏️ Built-in editor - Edit files directly with vim-like interface
• 🔒 Safe editing - Read-only mode with insert mode protection

Installation

pip install vtree-tree

Usage

# View current directory
vtree

# View specific directory
vtree /path/to/directory

# Get help
vtree --help

Keyboard Shortcuts

Key	Action
q / Ctrl+C	Quit
r	Refresh tree
f	Toggle hidden files
p	Toggle file panel mode
c	Copy current path to clipboard
d	Delete selected files/folders
e	Edit selected file
h / ?	Toggle help panel
↑↓←→	Navigate tree

View Modes

Inline Mode (Default)

Files and directories are shown together in a traditional tree structure.

Panel Mode

Press p to toggle panel mode where:

• Left panel shows only directories
• Right panel shows files in the selected directory with details (size, date)
• Perfect for browsing large directories

Copy to Clipboard

Press c to copy the current path to your clipboard:

• On a folder: Copies the folder path
• On a file: Copies the parent directory path

Great for quickly navigating in terminal sessions:

vtree
# Press 'c' on desired folder
cd # Paste path here

File Editing

vtree includes a built-in text editor with vim-like workflow:

Opening Files

Press e on any file to open it in read-only mode:

• View file contents without risk of accidental changes
• Navigate through the file with arrow keys

Editing Mode

Once in the file viewer, press i to enter insert mode:

• Now you can edit the file content
• The title bar shows "Insert Mode" to indicate editing is active
• Press Ctrl+S to save your changes

Safety Features

• Read-only by default: Files open in view-only mode
• Unsaved changes warning: If you try to close with unsaved changes, you'll get a confirmation dialog:
  • Y: Save and close
  • N: Close without saving
  • Esc: Cancel and return to editing

Editor Controls

Key	Action
e	Open file in read-only mode
i	Enter insert/edit mode (when viewing)
Ctrl+S	Save file (when editing)
Esc	Close editor

Requirements

• Python 3.8+
• Works on macOS, Linux, and Windows
• Terminal with color support

Dependencies

• textual - Modern TUI framework
• rich - Terminal formatting and colors
• click - Command-line interface

License

MIT License - see LICENSE file for details.

Contributing

Contributions welcome! Please feel free to submit a Pull Request.