/vim-netranger

A ranger-like system/cloud storage explorer for Vim, bringing together the best of Vim, ranger, and rclone.

Primary LanguagePythonOtherNOASSERTION

This repo is deprecated in favor of ranger.nvim.

vim-netranger

Build Status

Screen Shot

  • Copy/Cut/Paste in multiple windows copy/cut/paste
  • Preview/Panel mode preview
  • Inline Rename rename
  • Batch Pick (visual mode) for Delete (or copy/cut) pick
  • New File/Directory new
  • Sort sort
  • Open file with external programs (rifle) rifle
  • Image preview image
  • Inline Search search
  • Integration with built-in fold (zf) fold

Recent Update

  • Image preview is supported (Linux, X11). Please install ueberzug: pip install ueberzug
  • Bookmark functions are deprecated. Please use thirdparty plugins such as ipod825/vim-bookmark.
  • The setting g:NETROpenCmd is now set to NETRNewTabdrop, which close the netranger buffer. If you prefer the old behavior, you can have let g:NETROpenCmd=NETRTabdrop.
  • Preview window is on now by default. To turn it off, set g:NETRPreviewDefaultOn=v:false.

Vim-netranger is a ranger-like system/cloud storage explorer for Vim/Neovim. It brings together the best of Vim, ranger, and rclone:

  1. Against Vim (netrw):
    • Fancy rendering
    • Supports various cloud storages (via rclone)
  2. Against ranger:
    • Native Vim key-binding rather than just mimicking Vim
  3. Against rclone
    • Display/modify remote content without typing commands in terminal

Installation

Using vim-plug

Plug 'ipod825/vim-netranger'

Note: Other explorer plugins (e.g. NERDTree) might prohibit vim-netranger. You must disable them to make vim-netranger work.

Requirements

  1. vim & neovim

    • echo has('python3') should output 1
    • echo has('virtualedit') should output 1

  2. rclone: v1.4.0(v1.3.9) or newer (1.4.0 not yet published, see Known Issues). rclone is needed if you use remote editing features. However, it will be installed automatically on the first time running NETRemoteList command.

Workflow preferences

  1. If you are more used to tabpages, and want to always keep a netranger buffer for the project folder. Have let g:NETROpenCmd = 'NETRTabdrop' in your vimrc.
  2. If you are more used to tabpages, but want to close the netranger when openning a file. Have let g:NETROpenCmd = 'NETRNewTabdrop' in your vimrc.
  3. If you are not used to tabpages, let g:NETROpenCmd = 'NETRNewTabdrop' is still a good option for you. Otherwise, customize it to your favorite command.

Usage

:help vim-netranger-usage

Remote storage

:help vim-netranger-rclone

Customization

:help vim-netranger-customization-mapping
:help vim-netranger-customization-option

Advanced Key mappings:

:help vim-netranger-functions

Colors

:help vim-netranger-colors

Python Api

:help vim-netranger-api

Known Issues

  1. When remote directory is empty, it will not be copied to remote. It is an rclone [bug] (rclone/rclone#1837), which is expected to be fixed in next release.
  2. In some cases when listchars is set, vim-netranger buffer does not display correctly. For possible solutions, see the comment in this issue.
  3. taboo.vim incompatibility.

Contributing

Pull request is welcomed. However, please run tests before sending pull request.

Testing

$ cd test
$ bash test.sh  # test with visualization, xterm required
$ python test.py # test without visualization

Acknowledgements

Inspiration/codesnippet from other projects

  • NETRSearch filter in place inspired by fin.vim