Home

Awesome

<p align="center"> <img src="https://github.com/obaland/contents/blob/main/vfiler.vim/logo.png?raw=true" alt="vfiler-logo" width=75% height=auto> </p>

File explorer plugin for Neovim/Vim

CI Lint

Description

demo

Requirements

vfiler.vim requires Neovim(0.8.0+) or Vim8.2+ with if_lua.

Installation

Using vim-plug

Plug 'obaland/vfiler.vim'

Using dein.vim

call dein#add('obaland/vfiler.vim')

Using packer.nvim

use {
  'obaland/vfiler.vim',
}

Usage

Quick Start

Basically, after installing in any way, start with the VFiler command. The vfiler.vim will start in the current directory.

:VFiler

You can do various things with options.<br> See command usage for details.

Start by Lua function

vfiler.vim can also be started by calling a require'vfiler'.start().

require('vfiler').start({path})

You can do various things with configs.<br> See Lua function usage for details.

More details

Customization

vfiler.vim can be customized to your liking.<br> The following is an example.

Explorer style

Start by command:

:VFiler -auto-cd -auto-resize -keep -layout=left -name=explorer -width=30 -columns=indent,icon,name

Start by Lua script:

require('vfiler/config').setup {
  options = {
    auto_cd = true,
    auto_resize = true,
    keep = true,
    layout = 'left',
    name = 'explorer',
    width = 30,
    columns = 'indent,icon,name',
  },
}

require('vfiler').start()

More details

vfiler.vim has various other customization mechanisms.<br>

Extension plugins

There are also some extension plugins for vfiler.vim.<br> Please use it as you like.

Screenshots

Basic (with devicons)

basic

Operation with two buffers

multiple

Explorer style (with devicons)

tree

Floating window style (only Neovim)

tree

Feedback

I am hoping to continually improve it as far as time permits.<br> Welcome your requests and suggestions, so please create an issue.

License

vfiler.vim is licensed under the MIT license.<br> Copyright © 2018, obaland