如果您想进一步缩小命令返回的结果，请按 Ctrl-Q 切换到交互模式。

执行外部程序

您可以设置键盘绑定来启动外部进程而无需离开 skim（execute，execute-silent）。

# Press F1 to open the file with less without leaving skim
# Press CTRL-Y to copy the line to clipboard and aborts skim (requires pbcopy)
sk --bind 'f1:execute(less -f {}),ctrl-y:execute-silent(echo {} | pbcopy)+abort'

预览窗口

这是 fzf 的一个很棒的功能，skim 采用了这个功能。例如，我们使用 'ag' 来查找匹配的行，一旦我们缩小到目标行，我们最终想要通过检查行周围的上下文来决定选择哪些行。 grep 和 ag 有一个选项 --context，Skim 可以通过预览窗口做得更好。例如

sk --ansi -i -c 'ag --color "{}"' --preview "preview.sh {}"

（注意：preview.sh 是一个脚本，用于打印给定文件名：行：列的上下文）您会得到如下内容

它是如何工作的？

如果通过 --preview 选项提供了预览命令，Skim 将将 {} 替换为当前高亮的行，调用命令获取输出，并在预览窗口中打印输出。

有时您不需要整行来调用命令。在这种情况下，您可以使用{}、{1..}、{..3}或{1..5}来选择字段。语法在“字段支持”一节中解释。

最后，您可能想配置预览窗口的位置，使用--preview-window。

• --preview-window up:30%将窗口置于上方，高度为skim总高度的30%。
• --preview-window left:10:wrap，指定wrap允许预览窗口包裹预览命令的输出。
• --preview-window wrap:hidden在启动时隐藏预览窗口，之后可以通过toggle-preview动作显示。

字段支持

通常只有插件用户需要理解这一点。

例如，您有如下格式的数据源

<filename>:<line number>:<column number>

然而，当在查询中输入时，您只想搜索<filename>。这意味着当您输入21时，您想找到一个包含<filename>且包含21的文件，而不是匹配行号或列号。

您可以使用sk --delimiter ':' --nth 1来实现这一点。

您还可以使用--with-nth来重新排列字段的顺序。

范围语法

• <num> -- 指定第num个字段，从1开始。
• start.. -- 从第start个字段开始，包括剩余的字段。
• ..end -- 从第0个字段开始，一直到最后一个字段end，包括end。
• start..end -- 从第start个字段开始，一直到最后一个字段end，包括end。

作为库使用

Skim可以作为您的Rust包中的库使用。

首先，将skim添加到您的Cargo.toml

[dependencies]
skim = "*"

然后尝试运行这个简单的示例

extern crate skim;
use skim::prelude::*;
use std::io::Cursor;

pub fn main() {
    let options = SkimOptionsBuilder::default()
        .height(Some("50%"))
        .multi(true)
        .build()
        .unwrap();

    let input = "aaaaa\nbbbb\nccc".to_string();

    // `SkimItemReader` is a helper to turn any `BufRead` into a stream of `SkimItem`
    // `SkimItem` was implemented for `AsRef<str>` by default
    let item_reader = SkimItemReader::default();
    let items = item_reader.of_bufread(Cursor::new(input));

    // `run_with` would read and show items from the stream
    let selected_items = Skim::run_with(&options, Some(items))
        .map(|out| out.selected_items)
        .unwrap_or_else(|| Vec::new());

    for item in selected_items.iter() {
        print!("{}{}", item.output(), "\n");
    }
}

给定一个 Option<SkimItemReceiver>，skim 将根据其读取项目，执行其任务，并返回用户选择，包括选定的项目、查询等。注意

• SkimItemReceiver 是 crossbeam::channel::Receiver<Arc<dyn SkimItem>>
• 如果没有，它将调用给定的命令并从命令输出中读取项目
• 否则，它将从（crossbeam）通道中读取项目。

特质 SkimItem 提供了自定义一行如何显示、比较和预览的方法。它默认实现了 AsRef<str>

此外，SkimItemReader 是一个将 BufRead 转换为 SkimItemReceiver 的辅助工具（我们可以轻松地将 File 转换为 BufRead）。这样你就可以轻松处理字符串或文件。

更多示例请查看 examples/ 目录。

常见问题解答

如何忽略文件？

Skim 调用 find . 获取用于过滤的文件列表。你可以通过设置环境变量 SKIM_DEFAULT_COMMAND 来覆盖它。例如

$ SKIM_DEFAULT_COMMAND="fd --type f || git ls-tree -r --name-only HEAD || rg --files || find ."
$ sk

如果你喜欢它作为默认值，可以将其放入你的 .bashrc 或 .zshrc

有些文件在 Vim 插件中不会显示

如果你使用 Vim 插件并执行 :SK 命令，你可能会发现一些文件没有显示。

如 #3 中所述，在 Vim 插件中，SKIM_DEFAULT_COMMAND 默认设置为命令

let $SKIM_DEFAULT_COMMAND = "git ls-tree -r --name-only HEAD || rg --files || ag -l -g \"\" || find ."

这意味着，git 识别不了的那些文件将不会显示。要么用 let $SKIM_DEFAULT_COMMAND = '' 覆盖默认值，要么自己查找缺失的文件。

与 fzf 的区别

fzf 是一个用 Go 编写的命令行模糊查找器，而 skim 尝试在 Rust 中实现一个新的版本！

该项目是从头开始的。一些实现决策与 fzf 不同。例如

1. skim 是一个二进制文件以及库，而 fzf 只是一个二进制文件。
2. skim 有一个交互式模式。
3. skim 支持预选择
4. 模糊搜索算法不同。
5. 显示匹配项的 UI。 fzf 将只显示匹配的范围，而 skim 将显示每个匹配的字符。（fzf 现在有这个功能了）
6. skim 的范围语法是 Git 风格：现在它与 fzf 相同。

如何贡献

如果您遇到任何错误或有任何想法，请创建新问题。拉取请求非常受欢迎。