ranger

This file describes ranger and how to get it to run. For instructions on the usage, please read the man page ( man ranger in a terminal). See HACKING.md for development-specific information. For configuration, check the files in ranger/config/ or copy the default config to ~/.config/ranger with ranger --copy-config (see instructions). The examples/ directory contains several scripts and plugins that demonstrate how ranger can be extended or combined with other programs. These files can be found in the git repository or in /usr/share/doc/ranger . A note to packagers: Versions meant for packaging are listed in the changelog on the website. 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 Tabs, bookmarks, mouse support... img2txt (from caca-utils ) for ASCII-art image previews w3mimgdisplay , ueberzug , mpv , iTerm2 , kitty (or other terminal supporting the Kitty graphics protocol), terminology or urxvt for image previews convert (from imagemagick ) to auto-rotate images and for image previews rsvg-convert (from librsvg ) for SVG previews ffmpeg , or ffmpegthumbnailer for video thumbnails highlight , bat or pygmentize for syntax highlighting of code atool , bsdtar , unrar and/or 7zz to preview archives bsdtar , tar , unrar , unzip and/or zipinfo (and sed ) to preview archives as their first image lynx , w3m or elinks to preview html pages pdftotext or mutool (and fmt ) for textual pdf previews, pdftoppm to preview as image djvutxt for textual DjVu previews, ddjvu to preview as image calibre or epub-thumbnailer for image previews of ebooks transmission-show for viewing BitTorrent information mediainfo or exiftool for viewing information about media files odt2txt for OpenDocument text files ( odt , ods , odp and sxw ) python or jq for JSON files sqlite3 for listing tables in SQLite database (and optionally sqlite-utils for fancier box drawing.) jupyter nbconvert for Jupyter Notebooks fontimage for font previews openscad for 3D model previews ( stl , off , dxf , scad , csg ) draw.io for draw.io diagram previews ( drawio extension) Use the package manager of your operating system to install ranger. You can also install ranger through PyPI: pip install ranger-fm . However, it is recommended to use pipx instead (to benefit from isolated environments). Use pipx run --spec ranger-fm ranger to install and run ranger in one step. Installing from a clone Note that you don't have to install ranger; you can simply run ranger.py . This also saves a list of all installed files to install log.txt , which you can use to uninstall ranger. Ranger can automatically copy default configuration files to ~/.config/ranger if you run it with the switch --copy-config=( rc scope ... all ) . See ranger --help for a description of that switch. Also check ranger/config/ for the default configuration. To get the most out of ranger, read the Official User Guide. For frequently asked questions, see the FAQ. For more information on customization, see the wiki.