Skip to content

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

License

Notifications You must be signed in to change notification settings

eyalk5/vim-netranger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vim-netranger

Build Status Screenshot

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.

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.

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

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.7%
  • Vim Script 5.2%
  • Shell 0.1%