Skip to content

m-mdy-m/ftx.vim

🐉 ftx.vim — Fast Tree eXplorer for Vim/Neovim

Support Vim 8.0+ Support Neovim 0.4+ MIT License GitHub Release Doc CI Status

ftx tree screenshot

FTX is a pure Vim script, asynchronous file tree explorer focused on speed, clean UX, and extensibility.


Features

  • ⚡ Async tree build/update (keeps editor responsive)
  • 🌿 Git-aware tree (files + directories)
  • 🪟 Split-window and drawer workflows

Installation

Use your plugin manager.

" vim-plug
Plug 'm-mdy-m/ftx.vim'
" dein
call dein#add('m-mdy-m/ftx.vim')

Usage

Quick Start

:FTX .
:FTX %:h
:FTX . -drawer
:FTXToggle

When you run vim ., FTX auto-opens on that directory.

Documentation

Developer / Plugin API

FTX exposes lightweight extension points:

  • Hook events (tree:opened, tree:rendered, tree:closed)
  • Register custom file openers (for fzf, debugger integrations, etc.)

See doc/developer.md for examples.

Requirements

  • Vim 8.0+
  • OR Neovim 0.4+

Contributing

Contributions are welcome. See CONTRIBUTING.md.

License

MIT — see LICENSE.

Credits

Inspired by:

  • netrw - Vim's built-in file browser
  • NERDTree - Popular tree explorer
  • fern.vim - Modern async file explorer
  • ranger.vim.vim - integration in vim and neovim

About

file tree eXplore

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors