Skip to main content

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

MIT

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

tree_copy-0.1.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

tree_copy-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file tree_copy-0.1.0.tar.gz.

File metadata

  • Download URL: tree_copy-0.1.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for tree_copy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e17f7b2e5abf7293cc0d492ec58cb3388d0026f1313225f41a19448dc4090f34
MD5 8ab167ed8b349504496b76ada9891135
BLAKE2b-256 4ac5c3b324f54568892951ea1d6d7eec2dc2bb92cf2f918f406f5d862205d234

See more details on using hashes here.

File details

Details for the file tree_copy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tree_copy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for tree_copy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2750601d409935a00fba2d38f80fb7c806aa2aed3565d8d5aecfa92ca1b8b2c
MD5 2b68265897e96aa08577981993246e31
BLAKE2b-256 703df0f6675ce257b883cc405e539e25ce483376459196cdf2e05e080b9b2435

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