ranger-async is unstable, fake and buggy personal learning project for Python
asyncio stuff which brings None
improvements to the ranger FM.
Use https://github.com/ranger/ranger original instead.
ranger-async is a console file manager with VI key bindings. It provides a
minimalistic and nice curses interface with a view on the directory hierarchy.
It ships with rifle
, a file launcher that is good at automatically finding
out which program to use for what file type.
For mc
aficionados there's also the multi-pane viewmode.
This file describes ranger-async and how to get it to run. For instructions on the
usage, please read the man page (man ranger-async
in a terminal). See HACKING.md
for development-specific information.
For configuration, check the files in ranger_async/config/
or copy the
default config to ~/.config/ranger-async
with ranger-async --copy-config
(see instructions).
The examples/
directory contains several scripts and plugins that demonstrate how
ranger-async can be extended or combined with other programs. These files can be
found in the git repository or in /usr/share/doc/ranger-async
.
A note to packagers: Versions meant for packaging are listed in the changelog on the website.
- Authors: see
AUTHORS
file - License: GNU General Public License Version 3
- Website: TODO: fix website link
- Download: TODO: fix download link
- Bug reports: https://github.com/ekotik/ranger-async/issues
- git clone https://github.com/ekotik/ranger-async.git
- An easily maintainable file manager in a high level language
- A quick way to switch directories and browse the file system
- Keep it small but useful, do one thing and do it well
- Console-based, with smooth integration into the unix shell
- UTF-8 Support (if your Python copy supports it)
- Multi-column display
- Preview of the selected file/directory
- Common file operations (create/chmod/copy/delete/...)
- Renaming multiple files at once
- VIM-like console and hotkeys
- Automatically determine file types and run them with correct programs
- Change the directory of your shell after exiting ranger-async
- Tabs, bookmarks, mouse support...
- Python (
>=2.6
or>=3.1
) with thecurses
module and (optionally) wide-unicode support - A pager (
less
by default)
For general usage:
file
for determining file typeschardet
(Python package) for improved encoding detection of text filessudo
to use the "run as root" featurepython-bidi
(Python package) to display right-to-left file names correctly (Hebrew, Arabic)
For enhanced file previews (with scope.sh
):
img2txt
(fromcaca-utils
) for ASCII-art image previewsw3mimgdisplay
,ueberzug
,mpv
,iTerm2
,kitty
,terminology
orurxvt
for image previewsconvert
(fromimagemagick
) to auto-rotate images and for SVG previewsffmpegthumbnailer
for video thumbnailshighlight
,bat
orpygmentize
for syntax highlighting of codeatool
,bsdtar
,unrar
and/or7z
to preview archivesbsdtar
,tar
,unrar
,unzip
and/orzipinfo
(andsed
) to preview archives as their first imagelynx
,w3m
orelinks
to preview html pagespdftotext
ormutool
(andfmt
) for textualpdf
previews,pdftoppm
to preview as imagedjvutxt
for textual DjVu previews,ddjvu
to preview as imagecalibre
orepub-thumbnailer
for image previews of ebookstransmission-show
for viewing BitTorrent informationmediainfo
orexiftool
for viewing information about media filesodt2txt
for OpenDocument text files (odt
,ods
,odp
andsxw
)python
orjq
for JSON filesfontimage
for font previewsopenscad
for 3D model previews (stl
,off
,dxf
,scad
,csg
)
Use the package manager of your operating system to install ranger-async.
You can also install ranger-async through PyPI: pip install ranger-async-fm
.
Note that you don't have to install ranger-async; you can simply run ranger_async.py
.
To install ranger-async manually:
sudo make install
This translates roughly to:
sudo python setup.py install --optimize=1 --record=install_log.txt
This also saves a list of all installed files to install_log.txt
, which you can
use to uninstall ranger-async.
After starting ranger-async, you can use the Arrow Keys or h
j
k
l
to
navigate, Enter
to open a file or q
to quit. The third column shows a
preview of the current file. The second is the main column and the first shows
the parent directory.
Ranger-Async can automatically copy default configuration files to ~/.config/ranger-async
if you run it with the switch --copy-config=( rc | scope | ... | all )
.
See ranger-async --help
for a description of that switch. Also check
ranger_async/config/
for the default configuration.
- To get the most out of ranger-async, read the Official User Guide.
- For frequently asked questions, see the FAQ.
- For more information on customization, see the wiki.
For help, support, or if you just want to hang out with us, you can find us here:
- IRC: channel #ranger-async on freenode
- Reddit: r/ranger-async