## Вручную

Подходит любой из следующих способов:

- Использование скрипта установки:
    ```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 page), которую можно либо записать в правильный путь, либо запустить `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

Вы можете динамически переключиться в режим `regex`, нажав `Ctrl-R` (Rotate Mode).

## exit code

| Exit Code | Значение                            |
|-----------|-------------------------------------|
| 0         | Завершено нормально                 |
| 1         | Совпадений не найдено               |
| 130       | Прервано с помощью Ctrl-C/Ctrl-G/ESC и т.д. |

# Инструменты, совместимые с `skim`

Эти инструменты совместимы с `skim` или стремятся к этому:

## [fzf-lua neovim plugin](https://github.com/ibhagwan/fzf-lua)

Плагин для [neovim](https://neovim.io), позволяющий использовать fzf и skim для навигации по вашему коду.

Установите его с помощью вашего менеджера пакетов, следуя README. Например, с `lazy.nvim`:```lua
{
  "ibhagwan/fzf-lua",
  -- enable `sk` support instead of the default `fzf`
  opts = {'skim'}
}

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

Загружаемый модуль `sqlite`, который добавляет функцию `skim_score` в SQL-запросы.

# Настройка

Документация здесь — лишь краткий обзор, полный список опций смотрите в man-странице (`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: `sk --color=fg:#FF0000` (красный текст)

### Доступные параметры настройки цвета

Можно настроить следующие элементы интерфейса:

| Элемент             | Описание                                        | Пример                           |
|---------------------|-------------------------------------------------|----------------------------------|
| `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 принимает два вида источников: вывод команды или данные из конвейера (piped input)
- 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%` — разместить окно сверху с высотой
    30% от общей высоты skim.
- `--preview-window left:10:wrap` — указать `wrap`, что позволяет окну
    предпросмотра переносить вывод команды предпросмотра.
- `--preview-window wrap:hidden` — скрыть окно предпросмотра при запуске; позже
    его можно показать с помощью действия `toggle-preview`.

## Fields support

Обычно это нужно понимать только пользователям плагинов.

Например, у вас есть источник данных с форматом:```sh
<filename>:<line number>:<column number>

_Примечание о функциях_:
    - функция `cli` требуется для использования skim в качестве интерфейса командной строки; она *не должна* быть нужна при использовании его как библиотеки.

### Базовое использование

Затем попробуйте запустить этот простой пример:```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());
    }
}

Можно добавить это в ваш `.bashrc` или `.zshrc`, если хотите, чтобы оно было по умолчанию.

## Некоторые файлы не отображаются в плагине Vim

Если вы используете плагин Vim и выполняете команду `:SK`, вы можете обнаружить, что некоторые
из ваших файлов не отображаются.

Как описано в [#3](https://github.com/skim-rs/skim/issues/3), в плагине
Vim переменная `SKIM_DEFAULT_COMMAND` по умолчанию устанавливается на команду:```vim
let $SKIM_DEFAULT_COMMAND = "git ls-tree -r --name-only HEAD || rg --files || ag -l -g \"\" || find ."

Внутри виртуальной машины корень проекта смонтирован в `C:\vagrant`:```powershell
cd C:\vagrant
cargo build
cargo test

# Устранение неполадок

Чтобы разобраться в происходящем, вы можете задать переменную окружения `SKIM_LOG` или флаг `--log-level` со значением `debug` или даже `trace`, а также задать переменную окружения `SKIM_LOG_FILE` или флаг `--log-file` с указанием пути. Затем вы можете читать эти журналы во время или после выполнения, чтобы лучше понять, что происходит. Не стесняйтесь добавлять эти журналы в issue, если вам нужна помощь.

## Проблемы с переводами строк в 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` сравнивает skim (или любой совместимый бинарный файл) с другими версиями или fzf, запуская интерактивный интерфейс внутри сессии tmux и опрашивая строку состояния до тех пор, пока количество совпадений не стабилизируется. Это ни в коем случае не точное или безошибочное измерение, но оно имеет дополнительное преимущество — сравнение с `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