https://github.com/tmux-plugins/tmux-sidebar
A sidebar with the directory tree for the current path. Tries to make tmux more IDE like.
https://github.com/tmux-plugins/tmux-sidebar
Last synced: 6 days ago
JSON representation
A sidebar with the directory tree for the current path. Tries to make tmux more IDE like.
- Host: GitHub
- URL: https://github.com/tmux-plugins/tmux-sidebar
- Owner: tmux-plugins
- License: mit
- Created: 2014-09-03T14:29:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T08:58:28.000Z (over 2 years ago)
- Last Synced: 2024-11-15T10:43:24.594Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 89.8 KB
- Stars: 540
- Watchers: 8
- Forks: 31
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-tmux - tmux-sidebar
README
# Tmux Sidebar
`tmux-sidebar` does one thing: it opens a tree directory listing for the current
path. It's fast, convenient and works great with vim.
Some of the features that make the plugin more appealing than doing the same
thing manually each time:
- **fast**
Much faster than doing each step manually.
- **smart sizing**
Sidebar remembers its size, so the next time you open it, it will have the
**exact same** width. This is a per-directory property, so you can have just
the right size for multiple dirs.
- **toggling**
The same key binding opens and closes the sidebar.
- **uninterrupted workflow**
The main `prefix + Tab` key binding opens a sidebar but **does not** move
cursor to it.
- **pane layout stays the same**
No matter which pane layout you prefer, sidebar tries hard not to mess your
pane splits. Open, then close the sidebar and everything should look the same.
Requirements: `tmux 1.9` or higher, `tree` recommended but not required
Tested and working on Linux, OSX and Cygwin.
### Key bindings
- `prefix + Tab` - toggle sidebar with a directory tree
- `prefix + Backspace` - toggle sidebar and move cursor to it (focus it)
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
Add plugin to the list of TPM plugins in `.tmux.conf`:
set -g @plugin 'tmux-plugins/tmux-sidebar'
Hit `prefix + I` to fetch the plugin and source it. You should now be able to
use the plugin.
### Manual Installation
Clone the repo:
$ git clone https://github.com/tmux-plugins/tmux-sidebar ~/clone/path
Add this line to the bottom of `.tmux.conf`:
run-shell ~/clone/path/sidebar.tmux
Reload TMUX environment:
# type this in terminal
$ tmux source-file ~/.tmux.conf
You should now be able to use the plugin.
### Docs
- [customization options](docs/options.md)
### Other goodies
- [tmux-copycat](https://github.com/tmux-plugins/tmux-copycat) - a plugin for
regex searches in tmux and fast match selection
- [tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) - restore
tmux environment after a system restart
### License
[MIT](LICENSE.md)