如果您想进一步缩小由命令返回的结果，请按 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 -- 从第 end 个字段开始，直到第 end 个字段，包括 end。
• start..end -- 从第 start 个字段开始，直到第 end 个字段，包括 end。

作为库使用

Skim 可以在 Rust 的 crates 中作为库使用。

首先，将 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 相同。

如何贡献

如果你遇到任何错误或有任何想法，请创建新问题。拉取请求热烈欢迎。

qkzk 的注释

这是一个简单的分支，我在其中将一些属性公开，以便在另一个项目中使用 skim 作为内部程序，我在该项目中需要一个模糊查找器。

100% 的工作由原始作者完成，我对此不承担任何责任。