## 手動インストール

以下のいずれかが該当します:

- インストールスクリプトを使用する場合:
    ```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 では、skim プロファイルを指定して [fzf-lua](https://github.com/ibhagwan/fzf-lua) を確認してください）

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`（モード回転）を押すと、動的に `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) 内で使用できるようにする [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`
- RGB16進値：`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 は2種類のソースを受け付けます: コマンド出力またはパイプ入力
- Skimには2種類のプロンプトがあります: クエリパターンを指定するためのクエリプロンプトと、
    コマンドの「引数」を指定するためのコマンドプロンプト
- `-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 が指定された場合にコンテキストを出力するスクリプトです)

次のような結果が得られます:

![プレビューデモ](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` アクションで表示できます。

## Fields support

通常、この機能を理解する必要があるのはプラグインユーザーのみです。

例えば、次の形式のデータソースがあるとします:```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());
    }
}

`.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 ."

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