## 수동 설치

다음 중 하나에 해당하는 경우:

- 설치 스크립트 사용:
    ```sh
    # 실행 전에 항상 스크립트 내용을 확인하세요!
    $ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/skim-rs/skim/releases/latest/download/skim-installer.sh | sh
    ```
- 바이너리 사용: [sk 실행 파일을 직접 다운로드](https://github.com/skim-rs/skim/releases)하세요.
- [crates.io](https://crates.io/)에서 설치: `cargo install skim`
- 수동 빌드:
    ```sh
    $ git clone --depth 1 [email protected]:skim-rs/skim.git ~/.skim
    $ cd ~/.skim
    $ cargo build --release
    $ # 생성된 `target/release/sk` 실행 파일을 PATH에 추가하세요
    ```

그러면 다음에 접근할 수 있습니다:

- man 페이지: 올바른 경로에 작성하거나 `man --local-file <(sk --man)`을 실행할 수 있습니다.
- 셸 완성(및 선택적 키바인드): `source <(sk --shell \<shell> \[--shell-bindings])` 사용, 자세한 내용은 아래 참조.

# 사용법

Skim은 일반 필터(`grep`과 유사)로 사용하거나 명령을 실행하기 위한
대화형 인터페이스로 사용할 수 있습니다.

## Vim 플러그인으로 사용 (neovim에서는 [fzf-lua](https://github.com/ibhagwan/fzf-lua)를 skim 프로필과 함께 확인하세요)

vim-plug를 통한 설치(권장):

skim을 설치한 후:```vim
Plug 'skim-rs/skim'

이 마지막 명령은 ".rs" 확장자를 가진 파일을 선택할 수 있게 해주며, 선택한 파일을 Vim에서 엽니다. 개발자에게 큰 시간 절약이 됩니다!

## 대화형 인터페이스로 사용하기

`skim`은 다른 명령을 동적으로 호출할 수 있습니다. 일반적으로 프로젝트 디렉터리에서 내용을 검색할 때 [grep](https://www.gnu.org/software/grep/), [ack](https://github.com/petdance/ack2), [ag](https://github.com/ggreer/the_silver_searcher), 또는 [rg](https://github.com/BurntSushi/ripgrep)과 통합하고 싶을 것입니다:```sh
# works with grep
sk --ansi -i -c 'grep -rI --color=always --line-number {q} .'
# works with ack
sk --ansi -i -c 'ack --color {q}'
# works with ag
sk --ansi -i -c 'ag --color {q}'
# works with rg
sk --ansi -i -c 'rg --color=always --line-number {q}'

#### 옵션 2: 셸 시작 시 자동으로 로드되도록 파일에 저장```sh
# For bash, add to ~/.bashrc
echo 'source <(sk --shell bash)' >> ~/.bashrc  # Or save to ~/.bash_completion

# For zsh, add to ~/.zshrc
sk --shell zsh > ~/.zfunc/_sk  # Create ~/.zfunc directory and add to fpath in ~/.zshrc

# For fish, add to ~/.config/fish/completions/
sk --shell fish > ~/.config/fish/completions/sk.fish

`Ctrl-R`(Rotate Mode)를 누르면 동적으로 `regex` 모드로 전환할 수 있습니다.

## 종료 코드

| 종료 코드 | 의미                             |
|-----------|-------------------------------------|
| 0         | 정상 종료                     |
| 1         | 일치 항목 없음                      |
| 130       | Ctrl-C/Ctrl-G/ESC 등으로 중단됨... |

# `skim`과 호환되는 도구

다음 도구들은 `skim`과 호환되거나 호환을 목표로 합니다:

## [fzf-lua neovim 플러그인](https://github.com/ibhagwan/fzf-lua)

코드를 탐색하기 위해 fzf와 skim을 사용할 수 있게 해주는 [neovim](https://neovim.io) 플러그인입니다.

README에 따라 패키지 관리자로 설치하세요. 예를 들어, `lazy.nvim`을 사용하는 경우:```lua
{
  "ibhagwan/fzf-lua",
  -- enable `sk` support instead of the default `fzf`
  opts = {'skim'}
}

## [sqlite 확장](https://github.com/tzachar/sqlite_skim)

SQL 쿼리에서 `skim_score` 함수를 사용할 수 있게 해주는 로드 가능한 `sqlite` 모듈입니다.

# 사용자 지정

여기 문서는 미리보기일 뿐이며, 전체 옵션 목록은 매뉴얼 페이지(`man sk`)를 확인하세요.

## 키맵

바인딩을 쉼표로 구분된 쌍으로 지정합니다(공백 허용 안 됨). 예를 들어:```sh
sk --bind 'alt-a:select-all,alt-d:deselect-all'

Skim은 또한 `NO_COLOR` 환경 변수를 존중합니다. 이 변수에 아무 값이나 설정하면 `sk`(및 다른 많은 터미널 앱)는 모든 색상 출력을 비활성화합니다. 자세한 내용은 [no-color.org](https://no-color.org/)를 참조하세요.

### 사용 가능한 기본 색상 구성표

Skim에는 시작점으로 사용할 수 있는 여러 기본 제공 색상 구성표가 포함되어 있습니다:```sh
sk --color=dark      # Default dark theme (256 colors)
sk --color=light     # Light theme (256 colors)
sk --color=16        # Simple 16-color theme
sk --color=bw        # Minimal black & white theme (no colors, just styles)
sk --color=none      # Minimal black & white theme (no colors, no styles)
sk --color=molokai   # Molokai-inspired theme (256 colors)

색상은 여러 가지 방법으로 지정할 수 있습니다:

- ANSI 색상(0-255): `sk --color=fg:232,bg:255`
- RGB 16진수 값: `sk --color=fg:#FF0000` (빨간색 텍스트)

### 사용 가능한 색상 사용자 지정 옵션

다음 UI 요소를 사용자 지정할 수 있습니다:

| 요소               | 설명                                   | 예시                           |
|--------------------|----------------------------------------|--------------------------------|
| `fg`               | 일반 텍스트 전경색                     | `--color=fg:232`               |
| `bg`               | 일반 텍스트 배경색                     | `--color=bg:255`               |
| `matched`          | 검색 결과에서 일치하는 텍스트          | `--color=matched:108`          |
| `matched_bg`       | 일치하는 텍스트의 배경                 | `--color=matched_bg:0`         |
| `current`          | 현재 줄 전경색                         | `--color=current:254`          |
| `current_bg`       | 현재 줄 배경색                         | `--color=current_bg:236`       |
| `current_match`    | 현재 줄에서 일치하는 텍스트            | `--color=current_match:151`    |
| `current_match_bg` | 현재 줄에서 일치하는 텍스트의 배경     | `--color=current_match_bg:236` |
| `spinner`          | 진행 표시기 색상                       | `--color=spinner:148`          |
| `info`             | 정보 줄 색상                           | `--color=info:144`             |
| `prompt`           | 프롬프트 색상                          | `--color=prompt:110`           |
| `cursor`           | 커서 색상                              | `--color=cursor:161`           |
| `selected`         | 선택된 항목 표시자 색상                | `--color=selected:168`         |
| `header`           | 헤더 텍스트 색상                       | `--color=header:109`           |
| `border`           | 미리보기/레이아웃 테두리 색상          | `--color=border:59`            |

### 예시```sh
# Use light theme but change the current line background
sk --color=light,current_bg:24

# Custom theme with multiple colors
sk --color=dark,matched:#00FF00,current:#FFFFFF,current_bg:#000080

# High contrast theme
sk --color=fg:232,bg:255,matched:160,current:255,current_bg:20

### 어떻게 작동하나요?

![Skim의 대화형 모드 작동 방식](https://assets.kitploit.com/production/public/readmes/54416/5895df8cd6dbe8dfe20cafd1bf0b23fd690191710c00f811e110aba228b32a35/a7b995846d08eb2aa7f351371b38a9a35261eb393632363f62c6a67785f4038e-display-v1.webp)

- Skim은 두 종류의 소스를 허용합니다: 명령 출력 또는 파이프된 입력
- Skim에는 두 종류의 프롬프트가 있습니다: 쿼리 패턴을 지정하는 쿼리 프롬프트와
    명령의 "인자"를 지정하는 명령 프롬프트
- `-c`는 실행할 명령을 지정하는 데 사용되며 기본값은 `SKIM_DEFAULT_COMMAND`입니다
- `-i`는 시작 시 명령 프롬프트를 열도록 skim에 지시하며, 기본적으로 `c>`가 표시됩니다.

명령이 반환한 결과를 더 좁히려면 `Ctrl-Q`를 눌러 대화형 모드를 전환하세요.

## 외부 프로그램 실행

Skim을 종료하지 않고 외부 프로세스를 시작하도록 키 바인딩을 구성할 수 있습니다 (`execute`, `execute-silent`).```sh
# 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'

(참고로 [preview.sh](https://github.com/junegunn/fzf.vim/blob/master/bin/preview.sh)는 filename:lines:columns 형식이 주어졌을 때 컨텍스트를 출력하는 스크립트입니다)

다음과 같은 결과를 얻을 수 있습니다:

![preview demo](https://assets.kitploit.com/production/public/readmes/54416/b89dd1e40297ffc3fa4684c4a6d5dc9506c0eafdb881d4cea079ff843f1a271a/84156872f39354a97241078491506fee9f9962eda6628161f94f6f36ec2c79f9-display-v1.webp)

### 어떻게 동작하나요?

미리보기 명령이 `--preview` 옵션으로 주어지면, skim은 `{}`를 현재 강조 표시된 줄로 바꾸되 작은따옴표로 감싼 다음, 명령을 호출하여 출력을 얻고, 그 출력을 미리보기 창에 표시합니다.

때로는 명령을 호출하기 위해 전체 줄이 필요하지 않을 수도 있습니다. 이 경우 `{}`, `{1..}`, `{..3}` 또는 `{1..5}`를 사용하여 필드를 선택할 수 있습니다. 이 구문은 [Fields Support](#filds-support) 섹션에서 설명합니다.

마지막으로, `--preview-window`로 미리보기 창의 위치를 구성할 수 있습니다:
- `--preview-window up:30%`는 창을 위쪽 위치에 skim 전체 높이의 30% 높이로 배치합니다.
- `--preview-window left:10:wrap`는 `wrap`을 지정하여 미리보기 창이 미리보기 명령의 출력을 줄바꿈하도록 허용합니다.
- `--preview-window wrap:hidden`은 시작 시 미리보기 창을 숨기며, 이후 `toggle-preview` 동작으로 표시할 수 있습니다.

## 필드 지원

일반적으로 플러그인 사용자만 이해하면 되는 부분입니다.

예를 들어, 다음과 같은 형식의 데이터 소스가 있다고 가정합니다:```sh
<filename>:<line number>:<column number>

_기능 참고_:
    - `cli` 기능은 skim을 CLI로 사용할 때 필요하며, 라이브러리로 사용할 때는 *필요하지 않아야* 합니다.

### 기본 사용법

그런 다음 이 간단한 예제를 실행해 보세요:```rust
extern crate skim;
use skim::prelude::*;
use std::io::Cursor;

pub fn main() {
    let options = SkimOptionsBuilder::default()
        .height("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() {
        println!("{}", item.output());
    }
}

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

## Some files are not shown in Vim plugin

If you use the Vim plugin and execute the `:SK` command, you may find some
of your files not shown.

As described in [#3](https://github.com/skim-rs/skim/issues/3), in the Vim
plugin, `SKIM_DEFAULT_COMMAND` is set to the command by default:```vim
let $SKIM_DEFAULT_COMMAND = "git ls-tree -r --name-only HEAD || rg --files || ag -l -g \"\" || find ."

VM 내부에서 프로젝트 루트는 `C:\vagrant`에 마운트됩니다:```powershell
cd C:\vagrant
cargo build
cargo test

# 문제 해결

무슨 일이 일어나고 있는지 파악하려면 환경 변수 `SKIM_LOG` 또는 플래그 `--log-level`을 `debug` 또는 `trace`로 설정하고, 환경 변수 `SKIM_LOG_FILE` 또는 플래그 `--log-file`을 경로로 설정할 수 있습니다. 그런 다음 실행 중이나 실행 후에 해당 로그를 읽어 상황을 더 잘 이해할 수 있습니다. 도움이 필요하면 해당 로그를 이슈에 추가하는 것을 주저하지 마세요.

## nix, FreeBSD, termux에서의 줄 바꿈 문제 없음

다음과 같은 표시 문제가 발생하는 경우:```bash
$ for n in {1..10}; do echo "$n"; done | sk
  0/10 0/0.> 10/10  10  9  8  7  6  5  4  3  2> 1

# 벤치마크

## 대화형 벤치마크(`cli`)

`cli` 벤치는 tmux 세션 내에서 대화형 인터페이스를 실행하고 일치 항목 수가 안정화될 때까지 상태 줄을 폴링하여 skim(또는 호환되는 바이너리)을 다른 버전이나 fzf와 비교 측정합니다. 이는 결코 정밀하거나 완벽한 측정은 아니지만, `fzf`와 비교 측정할 수 있고 리소스 지표(최대 RSS 및 CPU)를 제공한다는 추가적인 이점이 있습니다.```sh
cargo bench --bench cli -- run                              # defaults: sk, 1 M items, query "test"
cargo bench --bench cli -- run sk -n 500000 -q foo              # bare name resolved via $PATH
cargo bench --bench cli -- run ./old/sk ./new/sk -r 5           # compare two binaries, 5 runs each
cargo bench --bench cli -- run sk -f input.txt -q search        # use an existing file
cargo bench --bench cli -- generate -f testdata.txt -n 2000000       # generate input file and exit
cargo bench --bench cli -- run sk --perf                            # record perf data (auto-named file)
cargo bench --bench cli -- run sk --strace                            # record strace data (auto-named file)
cargo bench --bench cli -- run sk -p perf.data                 # record perf data to perf.data
cargo bench --bench cli -- run sk -j                            # JSON output
cargo bench --bench cli -- run sk -r 3 -- --tiebreak=index     # pass extra flags to sk