终端文件管理工具ranger

2022-08-23

这是我终端配置文件教程的第一章，我将详细的讲解ranger安装，以及我的个人配置,快捷键等信息。

我的个人配置地址,可以去我的仓库抄我的配置,本文配置在ranger文件夹中, welcome to star🌟。

快捷键简记表

快捷键	作用
ra	终端启动文件管理ranger
	以下为ranger中的快捷键
q	退出ranger
l/Enter/Right	用相应编辑器打开文件
yy	复制文件
dd	移动文件
pp	粘贴
dD	删除
zh/<backspace>	显示隐藏或关闭隐藏文件
i	放大预览内容
<space>/v	选择文件
a	rename不改拓展名
A	rename改拓展名
m+任何字符	用此字符标记当前目录
‘+相应标记字符	快速跳转到被标记目录
A	rename改拓展名
T	新建单个文件(touch)
V	新建单个文件(nvim)
K	新建目录并进入目录
C	用v先选择要压缩文件，按C输入压缩包名即可压缩
X	按yy复制需解压文件，按X回车即可解压
cp	选择相应markdown文件，按cp即可转为pdf
cw	用v选择多个文件，可用cw调用nvim批处理文件名
f	查找过滤文件
<C-f>	调用fzf查找文件

ranger介绍

ranger官网地址,任何问题都可以github项目主页查看，wiki中都有解决措施。

ranger是一款在终端上的文件管理工具，有着VIM的哲学，可以很方便的用键盘对文件进行操作。

1.ranger安装

在macOS安装

安装ranger，即可使用基本功能

brew install ranger

安装依赖，这样可以使用一些扩展的功能,主要是预览相关的

brew install libcaca highlight atool lynx w3m elinks poppler transmission mediainfo exiftool

在ubuntu安装

安装ranger，即可使用基本功能

sudo apt-get install ranger

安装依赖，这样可以使用一些扩展的功能,主要是预览相关的

sudo apt-get install highlight atool lynx w3m elinks mediainfo

其他OS安装

查看项目主页中对应的安装方法。

2.功能配置

输入以下语句生成配置文件，或者直接复制我的ranger文件夹,直接将它复制到~/.config/目录下即可。

ranger --copy-config=all

现在，您可以转到~/.config/ranger生成的文件中：

cd ~/.config/ranger
➜  ranger ls -la
总用量 132
drwxr-xr-x 2 itkey users  4096  4月 13 16:25 .
drwxr-xr-x 6 itkey users  4096  4月 13 16:07 ..
-rw-r--r-- 1 itkey users 62106  4月 13 16:25 commands_full.py
-rw-r--r-- 1 itkey users  2763  4月 13 16:25 commands.py
-rw-r--r-- 1 itkey users 24193  4月 13 16:25 rc.conf
-rw-r--r-- 1 itkey users 14071  4月 13 16:25 rifle.conf
-rwxr-xr-x 1 itkey users 13758  4月 13 16:25 scope.sh

让我们快速浏览它们:

commands.py:可以编写自己的脚本命令，Wiki上有很多可借鉴
commands_full.py:全套命令，基本不动
rc.conf：配置与绑定
rifle.conf：文件关联（用于打开文件的程序）
scope.sh:负责各种文件预览

1.预览图片功能

首先需要修改rc.conf文件内容：

将set preview_images false修改为set preview_images true

将set preview_images_method w3m修改为set preview_images_method iterm2

在vim ~/.zshrc环境变量中增加下面一行
export RANGER_LOAD_DEFAULT_RC=FALSE

需要再写一个在终端可预览图片的命令vim imgcat,写入以下内容：

#!/bin/bash

# tmux requires unrecognized OSC sequences to be wrapped with DCS tmux;
# <sequence> ST, and for all ESCs in <sequence> to be replaced with ESC ESC. It
# only accepts ESC backslash for ST. We use TERM instead of TMUX because TERM
# gets passed through ssh.
function print_osc() {
    if [[ $TERM == screen* ]]; then
        printf "\033Ptmux;\033\033]"
    else
        printf "\033]"
    fi
}

# More of the tmux workaround described above.
function print_st() {
    if [[ $TERM == screen* ]]; then
        printf "\a\033\\"
    else
        printf "\a"
    fi
}

function load_version() {
    if [ -z ${IMGCAT_BASE64_VERSION+x} ]; then
        IMGCAT_BASE64_VERSION=$(base64 --version 2>&1)
        export IMGCAT_BASE64_VERSION
    fi
}

function b64_encode() {
    load_version
    if [[ $IMGCAT_BASE64_VERSION =~ GNU ]]; then
        # Disable line wrap
        base64 -w0
    else
        base64
    fi
}

function b64_decode() {
    load_version
    if [[ $IMGCAT_BASE64_VERSION =~ fourmilab ]]; then
        BASE64ARG=-d
    elif [[ $IMGCAT_BASE64_VERSION =~ GNU ]]; then
        BASE64ARG=-di
    else
        BASE64ARG=-D
    fi
    base64 $BASE64ARG
}

# print_image filename inline base64contents print_filename
#   filename: Filename to convey to client
#   inline: 0 or 1
#   base64contents: Base64-encoded contents
#   print_filename: If non-empty, print the filename
#                   before outputting the image
function print_image() {
    print_osc
    printf '1337;File='
    if [[ -n $1 ]]; then
        printf "name=%s;" "$(printf "%s" "$1" | b64_encode)"
    fi

    printf "%s" "$3" | b64_decode | wc -c | awk '{printf "size=%d",$1}'
    printf ";inline=%s" "$2"
    printf ":"
    printf "%s" "$3"
    print_st
    printf '\n'
    if [[ -n $4 ]]; then
        echo "$1"
    fi
}

function error() {
    echo "ERROR: $*" 1>&2
}

function show_help() {
    echo "Usage: imgcat [-p] filename ..." 1>&2
    echo "   or: cat filename | imgcat" 1>&2
}

function check_dependency() {
    if ! (builtin command -V "$1" >/dev/null 2>&1); then
        echo "imgcat: missing dependency: can't find $1" 1>&2
        exit 1
    fi
}

## Main

if [ -t 0 ]; then
    has_stdin=f
else
    has_stdin=t
fi

# Show help if no arguments and no stdin.
if [ $has_stdin = f ] && [ $# -eq 0 ]; then
    show_help
    exit
fi

check_dependency awk
check_dependency base64
check_dependency wc

# Look for command line flags.
while [ $# -gt 0 ]; do
    case "$1" in
    -h | --h | --help)
        show_help
        exit
        ;;
    -p | --p | --print)
        print_filename=1
        ;;
    -u | --u | --url)
        check_dependency curl
        encoded_image=$(curl -s "$2" | b64_encode) || (
            error "No such file or url $2"
            exit 2
        )
        has_stdin=f
        print_image "$2" 1 "$encoded_image" "$print_filename"
        set -- "${@:1:1}" "-u" "${@:3}"
        if [ "$#" -eq 2 ]; then
            exit
        fi
        ;;
    -*)
        error "Unknown option flag: $1"
        show_help
        exit 1
        ;;
    *)
        if [ -r "$1" ]; then
            has_stdin=f
            print_image "$1" 1 "$(b64_encode <"$1")" "$print_filename"
        else
            error "imgcat: $1: No such file or directory"
            exit 2
        fi
        ;;
    esac
    shift
done

# Read and print stdin
if [ $has_stdin = t ]; then
    print_image "" 1 "$(cat | b64_encode)" ""
fi

exit 0

把imgcat放到path中方便调用：

# 设置可执行权限
chmod +x imgcat
# 复制到path之中
cp imgcat /usr/local/bin/

现在你的ranger就可以预览图片咯

2.文件图标

图标插件地址

从github下载代码：

1 2	git clone https://github.com/alexanderjeurissen/ranger_devicons ~/.config/ranger/plugins/ranger_devicons echo "default_linemode devicons" >> $HOME/.config/ranger/rc.conf

重新进入ranger即可显示图标，当然你首先需要安装nerd font字体，我将另开篇文章讲解我的字体。

3.ranger调用fzf功能

首先你需要在commands.py文件中，加入以下代码：

class fzf_select(Command):
    """
    :fzf_select
    Find a file using fzf.
    With a prefix argument to select only directories.

    See: https://github.com/junegunn/fzf
    """

    def execute(self):
        import subprocess
        import os
        from ranger.ext.get_executables import get_executables

        if 'fzf' not in get_executables():
            self.fm.notify('Could not find fzf in the PATH.', bad=True)
            return

        fd = None
        if 'fdfind' in get_executables():
            fd = 'fdfind'
        elif 'fd' in get_executables():
            fd = 'fd'

        if fd is not None:
            hidden = ('--hidden' if self.fm.settings.show_hidden else '')
            exclude = "--no-ignore-vcs --exclude '.git' --exclude '*.py[co]' --exclude '__pycache__'"
            only_directories = ('--type directory' if self.quantifier else '')
            fzf_default_command = '{} --follow {} {} {} --color=always'.format(
                fd, hidden, exclude, only_directories
            )
        else:
            hidden = ('-false' if self.fm.settings.show_hidden else r"-path '*/\.*' -prune")
            exclude = r"\( -name '\.git' -o -iname '\.*py[co]' -o -fstype 'dev' -o -fstype 'proc' \) -prune"
            only_directories = ('-type d' if self.quantifier else '')
            fzf_default_command = 'find -L . -mindepth 1 {} -o {} -o {} -print | cut -b3-'.format(
                hidden, exclude, only_directories
            )

        env = os.environ.copy()
        env['FZF_DEFAULT_COMMAND'] = fzf_default_command
        env['FZF_DEFAULT_OPTS'] = '--height=40% --layout=reverse --ansi --preview="{}"'.format('''
            (
                batcat --color=always {} ||
                bat --color=always {} ||
                cat {} ||
                tree -ahpCL 3 -I '.git' -I '*.py[co]' -I '__pycache__' {}
            ) 2>/dev/null | head -n 100
        ''')

        fzf = self.fm.execute_command('fzf --no-multi', env=env,
                                      universal_newlines=True, stdout=subprocess.PIPE)
        stdout, _ = fzf.communicate()
        if fzf.returncode == 0:
            selected = os.path.abspath(stdout.strip())
            if os.path.isdir(selected):
                self.fm.cd(selected)
            else:
                self.fm.select_file(selected)

然后在rc.conf中配置以下快捷键即可，前提是你已经安装了fzf，我也将额外写一篇文章讲解。

map <C-f> fzf_select #use fzf

4.创建并进入文件夹功能

首先你需要在commands.py文件中，加入以下代码：

class mkcd(Command):
    """
    :mkcd <dirname>

    Creates a directory with the name <dirname> and enters it.
    """

    def execute(self):
        from os.path import join, expanduser, lexists
        from os import makedirs
        import re

        dirname = join(self.fm.thisdir.path, expanduser(self.rest(1)))
        if not lexists(dirname):
            makedirs(dirname)

            match = re.search('^/|^~[^/]*/', dirname)
            if match:
                self.fm.cd(match.group(0))
                dirname = dirname[match.end(0):]

            for m in re.finditer('[^/]+', dirname):
                s = m.group(0)
                if s == '..' or (s.startswith('.') and not self.fm.settings['show_hidden']):
                    self.fm.cd(s)
                else:
                    ## We force ranger to load content before calling `scout`.
                    self.fm.thisdir.load_content(schedule=False)
                    self.fm.execute_console('scout -ae ^{}$'.format(s))
        else:
            self.fm.notify("file/directory exists!", bad=True)

同样在rc.conf中配置快捷键：

map K console mkcd%space

5.压缩与解压缩功能

首先你需要在commands.py文件中，加入以下代码：

class compress(Command):
    def execute(self):
        """ Compress marked files to current directory """
        cwd = self.fm.thisdir
        marked_files = cwd.get_selection()

        if not marked_files:
            return

        def refresh(_):
            cwd = self.fm.get_directory(original_path)
            cwd.load_content()

        original_path = cwd.path
        parts = self.line.split()
        au_flags = parts[1:]

        descr = "compressing files in: " + os.path.basename(parts[1])
        obj = CommandLoader(args=['apack'] + au_flags + \
                [os.path.relpath(f.path, cwd.path) for f in marked_files], descr=descr, read=True)

        obj.signal_bind('after', refresh)
        self.fm.loader.add(obj)

    def tab(self, tabnum):
        """ Complete with current folder name """

        extension = ['.zip', '.tar.gz', '.rar', '.7z']
        return [
            'compress ' + os.path.basename(self.fm.thisdir.path) + ext
            for ext in extension
        ]


class extracthere(Command):
    def execute(self):
        """ Extract copied files to current directory """
        copied_files = tuple(self.fm.copy_buffer)

        if not copied_files:
            return

        def refresh(_):
            cwd = self.fm.get_directory(original_path)
            cwd.load_content()

        one_file = copied_files[0]
        cwd = self.fm.thisdir
        original_path = cwd.path
        au_flags = ['-X', cwd.path]
        au_flags += self.line.split()[1:]
        au_flags += ['-e']

        self.fm.copy_buffer.clear()
        self.fm.cut_buffer = False
        if len(copied_files) == 1:
            descr = "extracting: " + os.path.basename(one_file.path)
        else:
            descr = "extracting files from: " + os.path.basename(
                one_file.dirname)
        obj = CommandLoader(args=['aunpack'] + au_flags \
                + [f.path for f in copied_files], descr=descr, read=True)

        obj.signal_bind('after', refresh)
        self.fm.loader.add(obj)

同样在rc.conf中配置快捷键：

1 2	map C console compress%space map X console extracthere%space

6.其他相关功能

map T console shell touch%space #创建文件
map V console shell nvim%space  #nvim创建并编写文件
map cp shell pandoc %f -o %f.pdf #将md转为pdf
map cw eval fm.execute_console("bulkrename") if fm.thisdir.marked_items else fm.open_console("rename ") #批量重命名

set draw_borders true #显示边框线
set preview_max_size 2048000 # 只预览2MB以内的文件降低卡住概率
set colorscheme jungle #修改配色风格
set line_numbers relative #显示相对行号
set one_indexed true #行号默认是从0开始的，设置成从1开始
set one_indexed true #没预览时不折叠预览区，更舒服

好了，到现在你的ranger已经配置好了，熟能生巧，只有不断的使用，ranger才能提高你的生产效率。

参考资料

1.命令行文件管理神器ranger

2.把你的终端变成逆天高效神器：Ranger终极配置方案～

3.终端中的文件管理器ranger(csdn)