Skip to main content

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

Project description

vtree-tree

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

PyPI version Python

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

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
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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vtree_tree-2.0.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vtree_tree-2.0.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file vtree_tree-2.0.0.tar.gz.

File metadata

  • Download URL: vtree_tree-2.0.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for vtree_tree-2.0.0.tar.gz
Algorithm Hash digest
SHA256 8c6d4873b767fd48186d53c50e5841c4b54e73406f6524e2a14b169aeb8e1a48
MD5 bc8ffbc354d3f09c3d8d1e9329c5cb17
BLAKE2b-256 a2e752267c10861930515e5c9c8bbbd440e94254faeab0f661f6646c60280477

See more details on using hashes here.

File details

Details for the file vtree_tree-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: vtree_tree-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for vtree_tree-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 169ac0232c9544501fba0bfee2862a91ddf0c976a0dc89049d9c0d0621be25b7
MD5 57fa2b1f49a5e962aab5de0d2a4c6f85
BLAKE2b-256 d8ed0ef293434120acaeb36e0610fc14b769fca5545ce650c935f22b6ff66024

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page