{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/519", "result": {"data":{"issuesJson":{"id":"afcbbcc9-a682-5e51-a0c9-0b995db0357f","title":"lotabout/skim: 一个类似 grep 命令的通用的模糊查找器，可以节省您的时间。","number":519,"bodyHTML":"

\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Repos	lotabout/skim
Views	$\"views\"$
Stars	$\"stars\"$
Forks	$\"forks\"$
License	$\"license\"$
UpdatedAt	$\"last-commit\"$
CreatedAt	$\"create-at\"$

\n\n

\n

\n

\n

\n \n $\"Crates.io\"$ \n \n \n $\"Build$ \n \n \n $\"Packaging$ \n \n \n $\"Skim$ \n \n

\n

\n
Life is short, skim!
\n

\n

Half of our life is spent on navigation: files, lines, commands… You need skim!
\nIt's a general fuzzy finder that saves you time.

\n

\n

skim provides a single executable: sk. Anywhere you would want to use
\ngrep, try sk instead!

\n

Table of contents

\n

Installation\n
- Package Managers
- Manually
\n
Usage\n
- As Vim plugin
- As filter
- As Interactive Interface
- Shell Bindings
- Key Bindings
- Search Syntax
- exit code
\n
Tools compatible with skim\n
- fzf-lua neovim plugin
- nu_plugin_skim
\n
Customization\n
- Keymap
- Sort Criteria
- Color Scheme
- Misc
\n
Advanced Topics\n
- Interactive mode\n
  - How does it work?
  \n
- Executing external programs
- Preview Window\n
  - How does it work?
  \n
- Fields support
- Use as a library
- Tuikit
\n
FAQ\n
- How to ignore files?
- Some files are not shown in Vim plugin
\n
Differences from fzf
How to contribute
Troubleshooting\n
- No line feed issues with nix, FreeBSD, termux
\n

\n

Installation

\n

The skim project contains several components:

\n

sk executable -- the core.
sk-tmux -- script for launching sk in a tmux pane.
Vim/Nvim plugin -- to call sk inside Vim/Nvim. Check skim.vim for Vim support.

\n

Package Managers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

OS	Package Manager	Command
macOS	Homebrew	`brew install sk`
macOS	MacPorts	`sudo port install skim`
Fedora	dnf	`dnf install skim`
Alpine	apk	`apk add skim`
Arch	pacman	`pacman -S skim`
Gentoo	Portage	`emerge --ask app-misc/skim`
Guix	guix	`guix install skim`
Void	XBPS	`xbps-install -S skim`

\n\n $\"Packaging$ \n\n

Manually

\n

Any of the following applies:

\n

Using Git\n

$ git clone --depth 1 git@github.com:skim-rs/skim.git ~/.skim\n$ ~/.skim/install

\n

Using Binary: directly download the sk executable.
Install from crates.io: cargo install skim

Build Manually\n

$ git clone --depth 1 git@github.com:skim-rs/skim.git ~/.skim\n$ cd ~/.skim\n$ cargo install\n$ cargo build --release\n$ # put the resulting `target/release/sk` executable on your PATH.

\n

\n

Usage

\n

skim can be used as a general filter (like grep) or as an interactive
\ninterface for invoking commands.

\n

As Vim plugin

\n

Via vim-plug (recommended):

\n

Plug 'skim-rs/skim', { 'dir': '~/.skim', 'do': './install' }

\n

As filter

\n

Try the following:

\n

# directly invoke skim\nsk\n\n# or pipe some input to it: (press TAB key to select multiple items with -m enabled)\nvim $(find . -name \"*.rs\" | sk -m)

\n

The above command will allow you to select files with \".rs\" extension and open
\nthe ones you selected in Vim.

\n

As Interactive Interface

\n

skim can invoke other commands dynamically. Normally you would want to
\nintegrate it with grep,
\nack,
\nag, or
\nrg for searching contents in a
\nproject directory:

\n

# works with grep\nsk --ansi -i -c 'grep -rI --color=always --line-number \"{}\" .'\n# works with ack\nsk --ansi -i -c 'ack --color \"{}\"'\n# works with ag\nsk --ansi -i -c 'ag --color \"{}\"'\n# works with rg\nsk --ansi -i -c 'rg --color=always --line-number \"{}\"'

\n

\n
Note: in these examples, {} will be litterally expanded to the current input query.
\nThis does mean that these examples will search for the exact query string, and not fuzzily.
\nTo achieve fuzzy search, you need to pipe the command output into sk, without interactive mode.
\n

\n

$\"interactive$

\n

Shell Bindings

\n

Bindings for Fish, Bash and Zsh are available in the shell directory:

\n

completion.{shell} contains the completion scripts for sk cli usage
key-bindings.{shell} contains key-binds and shell integrations:\n
- ctrl-t to select a file through sk
- ctrl-r to select an history entry through sk
- alt-c to cd into a directory selected through sk
- (not available in fish) ** to complete file paths, for example ls **<tab> will show a sk widget to select a folder
\n

\n

To enable them, you need to source the key-bindings.{shell} file and enable the completions according to your shell's documentation (usually by placing them in the right directory).

\n

Key Bindings

\n

Some commonly used key bindings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Action
Enter	Accept (select current one and quit)
ESC/Ctrl-G	Abort
Ctrl-P/Up	Move cursor up
Ctrl-N/Down	Move cursor Down
TAB	Toggle selection and move down (with `-m`)
Shift-TAB	Toggle selection and move up (with `-m`)

\n

For the full list of key bindings, check out the man
\npage (man sk).

\n

Search Syntax

\n

skim borrows fzf's syntax for matching items:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Token	Match type	Description
`text`	fuzzy-match	items that match `text`
`^music`	prefix-exact-match	items that start with `music`
`.mp3$`	suffix-exact-match	items that end with `.mp3`
`'wild`	exact-match (quoted)	items that include `wild`
`!fire`	inverse-exact-match	items that do not include `fire`
`!.mp3$`	inverse-suffix-exact-match	items that do not end with `.mp3`

\n

skim also supports the combination of tokens.

\n

Whitespace has the meaning of AND. With the term src main, skim will search
\nfor items that match both src and main.
| means OR (note the spaces around |). With the term .md$ | .markdown$, skim will search for items ends with either .md or
\n.markdown.
OR has higher precedence. So readme .md$ | .markdown$ is grouped into
\nreadme AND (.md$ OR .markdown$).

\n

In case that you want to use regular expressions, skim provides regex mode:

\n

sk --regex

\n

You can switch to regex mode dynamically by pressing Ctrl-R (Rotate Mode).

\n

exit code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Exit Code	Meaning
0	Exited normally
1	No Match found
130	Aborted by Ctrl-C/Ctrl-G/ESC/etc...

\n

Tools compatible with `skim`

\n

These tools are or aim to be compatible with skim:

\n

fzf-lua neovim plugin

\n

A neovim plugin allowing fzf and skim to be used in a to navigate your code.

\n

Install it with your package manager, following the README. For instance, with lazy.nvim:

\n

{\n  \"ibhagwan/fzf-lua\",\n  -- enable `sk` support instead of the default `fzf`\n  opts = {'skim'}\n}

\n

nu_plugin_skim

\n

A nushell plugin to allow for better interaction between skim and nushell.

\n

Following the instruction in the plugin's README, you can install it with cargo:

\n

cargo install nu_plugin_skim\nplugin add ~/.cargo/bin/nu_plugin_skim

\n

Customization

\n

The doc here is only a preview, please check the man page (man sk) for a full
\nlist of options.

\n

Keymap

\n

Specify the bindings with comma separated pairs (no space allowed). For example:

\n

sk --bind 'alt-a:select-all,alt-d:deselect-all'

\n

Additionally, use + to concatenate actions, such as execute-silent(echo {} | pbcopy)+abort.

\n

See the KEY BINDINGS section of the man page for details.

\n

Sort Criteria

\n

There are five sort keys for results: score, index, begin, end, length. You can
\nspecify how the records are sorted by sk --tiebreak score,index,-begin or any
\nother order you want.

\n

Color Scheme

\n

It is a high chance that you are a better artist than me. Luckily you won't
\nbe stuck with the default colors - skim supports customization of the color scheme.

\n

--color=[BASE_SCHEME][,COLOR:ANSI]

\n

The configuration of colors starts with the name of the base color scheme,
\nfollowed by custom color mappings. For example:

\n

sk --color=current_bg:24\nsk --color=light,fg:232,bg:255,current_bg:116,info:27

\n

See the --color option in the man page for details.

\n

Misc

\n

--ansi: to parse ANSI color codes (e.g., \\e[32mABC) of the data source
--regex: use the query as regular expression to match the data source

\n

Advanced Topics

\n

Interactive mode

\n

In interactive mode, you can invoke a command dynamically. Try it out:

\n

sk --ansi -i -c 'rg --color=always --line-number \"{}\"'

\n

How does it work?

\n

\n

Skim accepts two kinds of sources: Command output or piped input
Skim has two kinds of prompts: A query prompt to specify the query pattern and a
\ncommand prompt to specify the \"arguments\" of the command
-c is used to specify the command to execute and defaults to SKIM_DEFAULT_COMMAND
-i tells skim to open command prompt on startup, which will show c> by default.

\n

If you want to further narrow down the results returned by the command, press
\nCtrl-Q to toggle interactive mode.

\n

Executing external programs

\n

You can set up key bindings for starting external processes without leaving skim (execute, execute-silent).

\n

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

\n

Preview Window

\n

This is a great feature of fzf that skim borrows. For example, we use 'ag' to
\nfind the matched lines, and once we narrow down to the target lines, we want to
\nfinally decide which lines to pick by checking the context around the line.
\ngrep and ag have the option --context, and skim can make use of --context for
\na better preview window. For example:

\n

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

\n

(Note that preview.sh is a script to print the context given filename:lines:columns)

\n

You get things like this:

\n

\n

How does it work?

\n

If the preview command is given by the --preview option, skim will replace the
\n{} with the current highlighted line surrounded by single quotes, call the
\ncommand to get the output, and print the output on the preview window.

\n

Sometimes you don't need the whole line for invoking the command. In this case
\nyou can use {}, {1..}, {..3} or {1..5} to select the fields. The
\nsyntax is explained in the section Fields Support.

\n

Lastly, you might want to configure the position of preview window with --preview-window:

\n

--preview-window up:30% to put the window in the up position with height
\n30% of the total height of skim.
--preview-window left:10:wrap to specify the wrap allows the preview
\nwindow to wrap the output of the preview command.
--preview-window wrap:hidden to hide the preview window at startup, later
\nit can be shown by the action toggle-preview.

\n

Fields support

\n

Normally only plugin users need to understand this.

\n

For example, you have the data source with the format:

\n

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

\n

However, you want to search <filename> only when typing in queries. That
\nmeans when you type 21, you want to find a <filename> that contains 21,
\nbut not matching line number or column number.

\n

You can use sk --delimiter ':' --nth 1 to achieve this.

\n

You can also use --with-nth to re-arrange the order of fields.

\n

Range Syntax

\n

<num> -- to specify the num-th fields, starting with 1.
start.. -- starting from the start-th fields and the rest.
..end -- starting from the 0-th field, all the way to end-th field,
\nincluding end.
start..end -- starting from start-th field, all the way to end-th
\nfield, including end.

\n

Use as a library

\n

Skim can be used as a library in your Rust crates.

\n

First, add skim into your Cargo.toml:

\n

[dependencies]\nskim = \"*\"

\n

Then try to run this simple example:

\n

extern crate skim;\nuse skim::prelude::*;\nuse std::io::Cursor;\n\npub fn main() {\n    let options = SkimOptionsBuilder::default()\n        .height(String::from(\"50%\"))\n        .multi(true)\n        .build()\n        .unwrap();\n\n    let input = \"aaaaa\\nbbbb\\nccc\".to_string();\n\n    // `SkimItemReader` is a helper to turn any `BufRead` into a stream of `SkimItem`\n    // `SkimItem` was implemented for `AsRef<str>` by default\n    let item_reader = SkimItemReader::default();\n    let items = item_reader.of_bufread(Cursor::new(input));\n\n    // `run_with` would read and show items from the stream\n    let selected_items = Skim::run_with(&options, Some(items))\n        .map(|out| out.selected_items)\n        .unwrap_or_else(|| Vec::new());\n\n    for item in selected_items.iter() {\n        println!(\"{}\", item.output());\n    }\n}

\n

Given an Option<SkimItemReceiver>, skim will read items accordingly, do its
\njob and bring us back the user selection including the selected items, the
\nquery, etc. Note that:

\n

SkimItemReceiver is crossbeam::channel::Receiver<Arc<dyn SkimItem>>
If it is none, it will invoke the given command and read items from command output
Otherwise, it will read the items from the (crossbeam) channel.

\n

Trait SkimItem is provided to customize how a line could be displayed,
\ncompared and previewed. It is implemented by default for AsRef<str>

\n

Plus, SkimItemReader is a helper to convert a BufRead into
\nSkimItemReceiver (we can easily turn a File or String into BufRead),
\nso that you could deal with strings or files easily.

\n

Check out more examples under the examples/ directory.

\n

Tuikit

\n

tuikit is the TUI framework used in skim. It is available from the library as skim::tuikit.

\n

Check the README for more details.

\n

FAQ

\n

How to ignore files?

\n

Skim invokes find . to fetch a list of files for filtering. You can override
\nthat by setting the environment variable SKIM_DEFAULT_COMMAND. For example:

\n

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

\n

You could put it in your .bashrc or .zshrc if you like it to be default.

\n

Some files are not shown in Vim plugin

\n

If you use the Vim plugin and execute the :SK command, you might find some
\nof your files not shown.

\n

As described in #3, in the Vim
\nplugin, SKIM_DEFAULT_COMMAND is set to the command by default:

\n

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

\n

That means, the files not recognized by git will not shown. Either override the
\ndefault with let $SKIM_DEFAULT_COMMAND = '' or find the missing file by
\nyourself.

\n

Differences from fzf

\n

fzf is a command-line fuzzy finder written
\nin Go and skim tries to implement a new one
\nin Rust!

\n

This project is written from scratch. Some decisions of implementation are
\ndifferent from fzf. For example:

\n

skim has an interactive mode.
skim supports pre-selection.
The fuzzy search algorithm is different.

\n

More generally, skim's maintainers allow themselves some freedom of implementation.
\nThe goal is to keep skim as feature-full as fzf is, but the command flags might differ.

\n

How to contribute

\n

Create new issues if you encounter any bugs
\nor have any ideas. Pull requests are warmly welcomed.

\n

Troubleshooting

\n

No line feed issues with nix, FreeBSD, termux

\n

If you encounter display issues like:

\n

$ for n in {1..10}; do echo \"$n\"; done | sk\n  0/10 0/0.> 10/10  10  9  8  7  6  5  4  3  2> 1

\n

For example

\n

skim-rs/skim#412
skim-rs/skim#455

\n

You need to set TERMINFO or TERMINFO_DIRS to the path of a correct terminfo database path

\n

For example, with termux, you can add this in your bashrc:

\n

export TERMINFO=/data/data/com.termux/files/usr/share/terminfo\n

","updatedAt":"2025-05-22T01:48:29Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"命令行工具","color":"e05879"}},{"node":{"name":"lotabout","color":"3d8ae9"}}]},"comments":{"edges":[]}}},"pageContext":{"number":519,"previous":{"title":"TeamStuQ/skill-map: 程序员技能图谱","number":518},"next":{"title":"skooner-k8s/skooner: 简单的 Kubernetes 实时仪表板和管理工具","number":520}}}, "staticQueryHashes": ["151096407","2861350382"]}