您可以在其 GitHub 页面 中找到这些发行版。

通过 cargo 安装

Scout 位于主要的 crates 仓库中，因此您可以使用 cargo 安装它

$ cargo install scout

请记住将 cargo 二进制路径添加到主 $PATH 环境变量中

export PATH=$PATH:~/.cargo/bin

通过 homebrew 安装（仅限 macOS）

您可以使用我的自定义 tap 仓库使用 homebrew 安装 scout

$ brew tap jhbabon/tap
$ brew install scout

通过 MacPorts 安装（仅限 macOS）

在macOS上，您还可以通过MacPorts安装scout。

$ sudo port install scout

从源码安装

scout是一个Rust项目，因此您需要在系统中安装Rust。请检查rustup以了解如何安装Rust。要构建scout，您需要Rust v1.43或更高版本。

克隆仓库并从中运行cargo install

$ git clone https://github.com/jhbabon/scout.git path/to/scout
$ cd path/to/scout
$ cargo install --path .

如果您只是想试一试，也可以运行cargo build --release。二进制文件将在./target/release/scout路径下。

用法

scout的主要思想，或者任何其他模糊查找器，都是过滤一个项目列表（例如文件路径列表），然后对所选内容进行一些操作。为此，您运行一个命令，将其输出管道传递给scout，然后将scout的输出管道传递给另一个命令。

例如，您可以尝试查找一个文件并cat其内容

$ find * -type f | scout | xargs -n1 cat

scout有一组选项，允许您控制其外观。它还支持一组控制序列和键来导航UI。

您可以使用--help标志在程序的主帮助中查看这些选项

scout 2.0.0
Your friendly fuzzy finder

USAGE:
    scout [FLAGS] [OPTIONS]

FLAGS:
    -f, --full-screen    Show scout in full screen (default)
    -h, --help           Prints help information
    -i, --inline         Show scout under the current line
    -p, --preserve-order Do not sort the result by score
    -v, --version        Prints version information

OPTIONS:
    -c, --config <FILE>     Uses a custom config file
    -l, --lines <LINES>     Number of lines to display in inline mode, including prompt
    -s, --search <QUERY>    Start searching with the given query

SUPPORTED KEYS:
    - Enter to select the current highlighted match and print it to STDOUT
    - ^u to clear the prompt
    - ^n or Down arrow key to select the next match
    - ^p or Up arrow key to select the previous match
    - ^e to go to the end of the prompt
    - ^a to go to the beginning of the prompt
    - Left arrow key to move the cursor to the left in the prompt
    - Right arrow key to move the cursor to the right in the prompt
    - ESC to quit without selecting a match

EXAMPLE:
    $ find * -type f | scout

    # Pass an initial query to start filtering right away
    $ find * -type f | scout --search=foo

    # Use a custom config file
    $ find * -type f | scout --config="./config.toml"

    # Select a git branch and check it out with an inline menu
    $ git branch --sort=-committerdate| cut -c 3- | scout -i -p | xargs git checkout

配置

您可以使用配置文件来配置scout的UI。默认情况下，程序将尝试在路径$HOME/.config/scout.toml中找到此文件，但您可以使用--config选项传递自定义路径。

这是没有定义样式的scout的外观

这是一个包含所有可能设置的配置文件的示例

# General screen options
[screen]
# Display inline (under the current line) or in full screen
mode = "inline" # or "full"
# Max number of lines to display the whole UI. Only used in inline mode
lines = 8

# The prompt is where you type your query
[prompt]
# Symbol displayed before the text you will type
symbol = "❯ "
# Style for the query (your text)
style = "bold underline"
# Style for the symbol
style_symbol = "fg:green"

# The gauge indicates the number of matches vs total number of lines
[gauge]
# Symbol used to separate both numbers
symbol = " ⚡"
# Text before the numbers
prefix = "- "
# Style for the numbers
style = "fg:bright-yellow"

# A candidate is an item in the list that is not selected
[candidate]
# Symbol displayed before the candidate's text
symbol = "❔ "
# Style for the candidate's text
style = "bg:red fg:black"
# Style for the symbol
style_symbol = "bg:red"
# A match is a character that is in both the query and the candidate
style_match = "underline bg:black fg:red bold"

# The selected candidate
[selection]
# Symbol displayed before the selection's text
symbol = "✅ "
# Style for the selection's text
style = "bg:green fg:black"
# Style for the symbol
style_symbol = "bg:green"
# A match is a character that is in both the query and the selection
style_match = "underline fg:bright-green bg:black"

将此配置放置在$HOME/.config/scout.toml中，将生成此UI

这并不漂亮，但它只是展示您可以做什么的一个例子。

样式由一个空格分隔的值string定义。我基于starship.rs配置系统来定义语法。

您可以使用以下值来定义样式

• underline：在文本下方画线
• strikethrough：用线划掉文本
• reverse：反转当前终端颜色
• bold：使用粗体字体
• italic：使用斜体字体（如果终端支持的话）
• dimmed：略微淡化前景颜色
• none：重置任何颜色，使用终端的默认值。这将忽略样式定义中的任何其他规则
• fg:<color-name>：使用指定的颜色作为前景（文本）颜色。可能的名称有 black、red、yellow、green、blue、purple、cyan、white。您还可以使用它们的明亮版本，带有 bright-* 前缀
• fg:<number>：使用指定的 ANSI 颜色 号码作为前景颜色
• fg:#<hex>：使用给定 RGB 颜色的十六进制表示作为前景颜色。例如 fg:#ffbbcc 将是 rgb(255, 187, 204)
• bg:<color-name>：与 fg: 相同，但用于背景
• bg:<number>：与 fg: 相同，但用于背景
• bg:#<hex>：与 fg: 相同，但用于背景