Skip to main content

Keyboard-driven file tree sidebar for tmux

Project description

tree-copy

screenshot

PyPI version Python versions License Downloads

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.

PyPI · GitHub

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.2.tar.gz (8.0 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.2-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tree_copy-0.1.2.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

Hashes for tree_copy-0.1.2.tar.gz
Algorithm Hash digest
SHA256 39e57222c27a28d4182e4929660ee183850f7e2524d45380b44101fd70e6749c
MD5 9c07accc9fc374fe643ea9ae2427321a
BLAKE2b-256 5ae5ab8a80e4fb16e81e385e0f0a01c4987b64c4bf92fb40edea5d991cb85f7b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tree_copy-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ca0b8f5f66b6ac57378544640fe34257951041f16abc993589855877cfbe829c
MD5 733123f2bc846cdb6580849eaa8bbde9
BLAKE2b-256 7044314614e21d1fec90009545b98a417582ee3e0f573a94ab6792490699b0ff

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