Keyboard-driven file tree sidebar for tmux
Project description
tree-copy
A keyboard-driven file tree sidebar for tmux, built with Textual.
Browse your project, jump between directories, copy paths, and preview files — without leaving the terminal.
Features
- Navigate the file tree with arrow keys
- Jump between sibling directories with
Shift+↑/↓ - Copy relative or absolute paths to clipboard
- Preview files with glow (falls back to
less) - Edit files with
$TREE_COPY_EDITOR(falls back to nano → vi) - Root folder stays open (non-collapsible)
Requirements
- Python 3.10+
- glow (optional, recommended for file preview — falls back to
less)
Install
pip install tree-copy
Or from source:
pip install .
Usage
tree-copy [directory] # defaults to current directory
As a togglable tmux sidebar, add to ~/.tmux.conf:
bind-key e run-shell " \
PANE=$(tmux show-option -wqv @tree-copy-pane); \
if [ -n \"$PANE\" ] && tmux list-panes -F '#{pane_id}' | grep -q \"^$PANE\$\"; then \
tmux kill-pane -t \"$PANE\"; \
tmux set-option -w @tree-copy-pane ''; \
else \
NEW_PANE=$(tmux split-window -hbP -l 35 -F '#{pane_id}' \"tree-copy '#{pane_current_path}'\"); \
tmux set-option -w @tree-copy-pane \"$NEW_PANE\"; \
fi"
prefix + e opens the sidebar; pressing it again closes it. State (expanded folders, cursor position) is saved automatically and restored on next open.
Keybindings
| Key | Action |
|---|---|
↑ / ↓ |
Navigate |
Shift+↑ / Shift+↓ |
Jump between sibling directories; moves to parent at bounds |
Enter / Space |
Toggle directory open/close |
o |
Preview file (glow if available, else less) |
e |
Edit file ($TREE_COPY_EDITOR, else nano, else vi) |
c |
Copy relative path to clipboard |
C |
Copy absolute path to clipboard |
q / Esc |
Quit |
License
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tree_copy-0.1.3.tar.gz.
File metadata
- Download URL: tree_copy-0.1.3.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4dc08ebb22ed45ebea79ac8c405c76d12ebf83bd1f02eb93b15aa30c0a2b08b
|
|
| MD5 |
ee1c88db0b82375907e1994473bbcd09
|
|
| BLAKE2b-256 |
f0c955f2475fded885346ab3d096c2cd483e73cc18d3c855403558112104547d
|
File details
Details for the file tree_copy-0.1.3-py3-none-any.whl.
File metadata
- Download URL: tree_copy-0.1.3-py3-none-any.whl
- Upload date:
- Size: 8.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
68b25e88ed695227287a6aa0caecdef75d58376bda1605c8ca1c91071300d27b
|
|
| MD5 |
f1d86d11d056755ff65f89c6e087a621
|
|
| BLAKE2b-256 |
06193d5c89f607d1cd8bc12147b982a59a84e62f48b000a578b3341e7f506176
|