Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreyorst/kaktree
File explorer side panel for Kakoune
https://github.com/andreyorst/kaktree
file-explorer filetree kakoune plugin
Last synced: 2 months ago
JSON representation
File explorer side panel for Kakoune
- Host: GitHub
- URL: https://github.com/andreyorst/kaktree
- Owner: andreyorst
- License: mit
- Archived: true
- Created: 2019-06-16T19:20:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-30T09:51:48.000Z (over 2 years ago)
- Last Synced: 2024-08-04T08:07:32.623Z (6 months ago)
- Topics: file-explorer, filetree, kakoune, plugin
- Language: KakouneScript
- Homepage:
- Size: 79.1 KB
- Stars: 51
- Watchers: 3
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# kaktree
This plugin displays the interactive file tree. It requires Perl, as well as
`ls` command that supports at least `-1`, `-F`, `-b`, `-L`, and `-A`
flags. Works best with Tmux.
## Installation
You need latest Kakoune build from master in order to use
this plugin.
### With [plug.kak](https://github.com/andreyorst/plug.kak)
Add this to your `kakrc`:
```sh
plug "andreyorst/kaktree" config %{
hook global WinSetOption filetype=kaktree %{
remove-highlighter buffer/numbers
remove-highlighter buffer/matching
remove-highlighter buffer/wrap
remove-highlighter buffer/show-whitespaces
}
kaktree-enable
}
```
Restart Kakoune or re-source your `kakrc` and call `plug-install` command.
### Without plugin manager
Clone this repository to your `autoload` directory, or source `kaktree.kak` file
from your `kakrc`.
It's strongly recommended to disable line numbers and wrap highlighters as shown
in the `plug.kak` example above.
## Configuration
There are set of options that affect how `kaktree` works:
- `kaktreeclient` - the name of the client that will be used to display
`kaktree` buffer.
- `kaktree_split` - how to split TMUX (horizontally or vertically).
- `kaktree_side` - the side where `kaktree` buffer will be displayed in TMUX.
- `kaktree_size` - size of the split.
- `kaktree_dir_icon_close` - icon for closed directory.
- `kaktree_dir_icon_open` - icon for opened directory.
- `kaktree_file_icon` - icon for files.
- `kaktree_show_hidden` - whether to show hidden files
- `kaktree_hlline` - configures highlighting of current line in the tree.
- `kaktree_sort` - whether to sort items in the tree.
- `kaktree_double_click_duration` - amount of time Kakoune waits to register
double clicks in the Kaktree.
- `kaktree_show_help` - whether to display help box on first launch of Kaktree.
- `kaktree_tab_open_file` - whether Kaktree should open file if Tab
key was pressed over it.
For example, to have nice folder and file icons as on the screenshot add this to
your configuration (assuming that your font has these characters and your
terminal can handle wide Unicode symbols):
```
plug "andreyorst/kaktree" defer kaktree %{
set-option global kaktree_double_click_duration '0.5'
set-option global kaktree_indentation 1
set-option global kaktree_dir_icon_open '▾ 🗁 '
set-option global kaktree_dir_icon_close '▸ 🗀 '
set-option global kaktree_file_icon '⠀⠀🖺'
} config %{...}
```
If you're not using plug.kak, replace `defer` with `hook global
ModuleLoaded`. Beware that `'⠀⠀🖺'` the first two characters here are not
ordinary spaces, but invisible Unicode symbols. Currently Kaktree handles tree
structure based on indentation, so in order to do alignment of icons you should
use something that doesn't match `\s` regexp atom.