設定は最初のリクエストの前にファイル全体に適用され、`###` はリクエストを区切り、ディレクティブはリクエストを繰り返したり、制限したり、検証したりできます。その他の例はこちら: [`_examples/`](https://github.com/unkn0wn-root/resterm/blob/main/_examples) を参照してください。

## CLI

`resterm run` は、TUI を開かずに `.http` / `.rest` ファイルを実行します。これは CI が実行する内容です。```bash
resterm run --request CreateUser requests.http

TUIでは、代わりに `g Shift+M` を押すと、ワークスペースから同じモックサーバーを起動できます。

[CLIドキュメント](https://github.com/unkn0wn-root/resterm/blob/main/docs/cli.md)では、セレクタ、出力形式、その他の例を説明しています。

## キーボードチートシート

- ペインのフォーカスとレイアウト
  - `Tab` / `Shift+Tab`: サイドバー、エディタ、レスポンス間を移動します。
  - `g+r`、`g+i`、`g+p`: リクエスト、エディタ、またはレスポンスにジャンプします。
  - `g+h` / `g+l`: 水平方向にリサイズします。サイドバーにフォーカスがある場合はサイドバーの幅を変更し、それ以外の場合はエディタ/レスポンスの分割を変更します。
  - `g+j` / `g+k`: 縦積みの場合はエディタ/レスポンスの高さをリサイズし、ナビゲータではブランチを折りたたんだり展開したりします。
  - `g+v` / `g+s`: レスポンスペインをインラインと縦積みのレイアウト間で切り替えます。
  - `g+1`、`g+2`、`g+3`: サイドバー、エディタ、レスポンスを最小化または復元します。
  - `g+z` / `g+Z`: フォーカス中のペインをズームし、ズームを解除します。
- 環境とグローバル
  - `Ctrl+E`: 環境を切り替えます。
  - `Ctrl+G`: 取得したグローバルを検査します。
- ヘルプとコマンド
  - `?`: 検索可能なオフラインヘルプインデックスを開きます。
  - `K`(エディタのノーマルモード): カーソル下のディレクティブ、テンプレート、またはキーワードのヘルプを開きます。
  - `:help <topic>` / `:man <topic>`: 埋め込みトピックを開きます。`:docs <topic>` はバージョン対応の完全マニュアルを開きます。
  - `Ctrl+O`: ファイル/ワークスペースのポップアップを開きます。入力してフィルタリングし、`Up` / `Down` でスクロールし、`Tab` でディレクトリに入ります。
  - `:`: コマンドラインを開きます。`Up` / `Down` で候補を選択し、`Tab` で補完し、`Enter` で選択を確定して実行します。`:mock start --source` や `:edit` などのパス引数は、同じポップアップでファイルシステムを参照します。
- レスポンス
  - `Ctrl+V` / `Ctrl+U`: レスポンスペインを分割して並べて比較します。
  - `Ctrl+Shift+C` または `g y`(レスポンスにフォーカス時): Pretty、Raw、または Headers タブ全体をコピーします。
  - `g x`: アクティブなリクエストを送信せずに Explain プレビューを表示します。
  - `g e`: 現在のファイルを外部エディタで開きます。

> [!TIP]
> 3つのショートカットだけ覚えておくなら:
> - `Ctrl+Enter` でリクエストを送信
> - `Tab` / `Shift+Tab` でペインを切り替え
> - `g+p` でレスポンスにジャンプ

## インストール

**Linux / macOS (Homebrew)**```bash
brew install resterm

または`wget`を使用する場合:```bash
wget -qO- https://raw.githubusercontent.com/unkn0wn-root/resterm/main/install.sh | bash

スクリプトはアーキテクチャを検出し、最新リリースをダウンロードしてバイナリをインストールします。

### 手動インストール

> [!NOTE]
> 手動インストールヘルパーは `curl` と `jq` を使用します。パッケージマネージャーで `jq` をインストールしてください（`brew install jq`、`sudo apt install jq` など）。

**Linux / macOS**```bash
# Detect latest tag
LATEST_TAG=$(curl -fsSL https://api.github.com/repos/unkn0wn-root/resterm/releases/latest | jq -r .tag_name)

# Download the matching binary (Darwin/Linux + amd64/arm64)
curl -fL -o resterm "https://github.com/unkn0wn-root/resterm/releases/download/${LATEST_TAG}/resterm_$(uname -s)_$(uname -m)"

# Make it executable and move it onto your PATH
chmod +x resterm
sudo install -m 0755 resterm /usr/local/bin/resterm

### ソースから```bash
go install github.com/unkn0wn-root/resterm/cmd/resterm@latest

最初のコマンドは、新しいリリースが利用可能かどうかを報告します。2番目のコマンドは、それをダウンロードして検証し、その場にインストールします。Windowsでは、古いバイナリは`resterm.exe.old`として新しいバイナリの隣に残り、次の更新時にクリーンアップされます。

## 設定

- 環境はJSONファイル（`resterm.env.json`）で、リクエストディレクトリ、ワークスペースルート、またはCWDで検出されます。ファイルは、api、app、credentialsなどの名前付き環境または独立したグループを定義でき、それらが1つの環境に結合されます。Dotenvファイル（`.env`、`.env.*`）は`--env-file`によるオプトインで、単一ワークスペース用です。[グループ化された環境](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#grouped-environments)と、`_examples/grouped/`にある実行可能なサンプルを参照してください。
- 設定はOSごとに保存され、`RESTERM_CONFIG_DIR`で上書きできます：
  - macOS: `~/Library/Application Support/resterm`
  - Windows: `%APPDATA%\resterm`
  - Linux/Unix: `~/.config/resterm`

## モックサーバー

リクエストと同じ`.http`ファイル内でモックレスポンスを定義できます。

- クエリ、ヘッダー、またはJSONボディで受信リクエストを照合し、名前付きまたはデフォルトのレスポンスを選択します。
- ポーリングやリトライテスト用に、レスポンスのシーケンスを返します。パス、クエリ、ヘッダー、またはCookie値を使用して、各シーケンスを個別に追跡します。
- 固定時間だけレスポンスを遅延させるか、`random`、`normal`、または`jitter`を使用してリクエストごとに異なる遅延を与えます。
- パス、クエリ、ヘッダー、ボディの値からレスポンスを構築し、動的データ用のジェネレーターを使用します。
- `@expect`で呼び出し回数を検証するか、RestermScriptから受信トラフィックを検査します。
- ソースファイルとフィクスチャをホットリロードし、オプションでTLSをサポートします。

1つのルート上の2つのシナリオ：```http
### Payment accepted
# @mock method=POST path=/payments name=accepted default=true latency=150ms
HTTP/1.1 202 Accepted
Content-Type: application/json

{"id":"pay_123","status":"pending"}

### Payment declined
# @mock method=POST path=/payments name=declined
# @match query={"mode":"decline"} headers={"X-Tenant":"demo"} json={"amount":0}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{"error":"amount must be positive"}

[Mock Servers リファレンス](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#mock-servers)、[`resterm mock` CLI ガイド](https://github.com/unkn0wn-root/resterm/blob/main/docs/cli.md#resterm-mock)、および[動作例](https://github.com/unkn0wn-root/resterm/blob/main/_examples/mocks.http)を参照してください。

## ヘッドレス

[`headless`](https://github.com/unkn0wn-root/resterm/blob/main/headless) パッケージは、TUI と CLI を支える同じエンジンに対する公開 Go API です。これを使用して、独自の Go コードや CI からリクエスト、ワークフロー、アサーションの実行、実行結果の比較、プロファイルの比較を行うことができます。

自分でランナーを構築したくない場合は、[resterm-runner](https://github.com/unkn0wn-root/resterm-runner) があります。

## コレクション

ワークスペースを Git フレンドリーなバンドルとしてエクスポートし、別のワークスペースにインポートします。バンドルにはチェックサム付きの `manifest.json` が含まれているため、インポート時にはまずファイルの整合性が検証されます。環境変数の値は `REPLACE_ME` プレースホルダーとしてエクスポートされるため、シークレットがマシンの外に出ることはありません。```bash
resterm collection export --workspace ./my-api --out ./shared/my-api-bundle
resterm collection import --in ./shared/my-api-bundle --workspace ./my-local-api

次のようになります：```http
### POST https://api.example.com/login
# @auth basic demo secret
POST https://api.example.com/login
Content-Type: application/json

{"user":"demo"}

I need the actual content of chunk 41 to translate it. Please provide the Markdown text you want translated.```http
# @use ./rts/helpers.rts
# @when env.has("feature")
# @assert response.statusCode == 200
GET https://api.example.com/users/{{= vars.get("user") }}
Authorization: {{= helpers.authHeader(vars.get("auth.token")) }}

例: [`_examples/oauth2.http`](https://github.com/unkn0wn-root/resterm/blob/main/_examples/oauth2.http)。[OAuth 2.0 ドキュメント](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#oauth-20-directive) を参照してください。

### ワークフローとスクリプティング

ワークフローは名前付きリクエストを連結し、レスポンスから次のステップを選択できます:```http
### Sign in
# @workflow sign-in
# @step Login using=Login
// GetProfile and RefreshToken are request names.
// The first true condition runs the named request.
# @if last.statusCode == 200 run=GetProfile
# @elif last.statusCode == 401 run=RefreshToken
# @else fail="unexpected login response"

各ポーリングサイクルには、それぞれ独自のリトライ予算が割り当てられます。例: [`_examples/polling-retries.http`](https://github.com/unkn0wn-root/resterm/blob/main/_examples/polling-retries.http)。[ポーリングとリトライのドキュメント](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#polling-and-retries)を参照してください。

### 実行の比較

`@compare` は、1つのリクエストを少なくとも2つの環境に対して実行し、そのうちの1つの結果をベースラインとして使用します:```http
### Compare health
# @compare dev stage prod base=prod
GET {{services.api.base}}/status

Timeline タブに結果が表示され、OpenTelemetry にエクスポートできます。例: [`_examples/trace.http`](https://github.com/unkn0wn-root/resterm/blob/main/_examples/trace.http)。[トレーシングドキュメント](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#timeline--tracing) を参照してください。

### ストリーミング (WebSocket と SSE)

`@sse` はサーバーイベントを記録し、`@websocket` と `@ws` は WebSocket フレームをスクリプト化します。どちらも Stream タブにトランスクリプトを生成します:```http
### Events
# @sse duration=30s idle=10s max-events=5
GET https://api.example.com/events

### Chat
# @websocket idle=3s
# @ws send Hello
# @ws close 1000 done
GET wss://api.example.com/chat

サーバーリフレクションはデフォルトで有効です。ディスクリプタセットとストリーミング呼び出しもサポートされています。例: [`_examples/grpc.http`](https://github.com/unkn0wn-root/resterm/blob/main/_examples/grpc.http)。[gRPCドキュメント](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#grpc)を参照してください。

### OpenAPIインポート

ローカルのOpenAPIドキュメントまたは`http(s)` URLから、リクエスト、モック、またはその両方を生成します:```bash
resterm --from-openapi _examples/openapi-spec.yml --http-out api.http --openapi-mode both

プロファイルはファイル全体またはワークスペース全体に適用でき、一回限りのインライン・トンネルもサポートされています。例: [`_examples/ssh.http`](https://github.com/unkn0wn-root/resterm/blob/main/_examples/ssh.http)。[SSHドキュメント](https://github.com/unkn0wn-root/resterm/blob/main/docs/resterm.md#ssh-tunnels)を参照してください。

### Kubernetesポートフォワード

`@k8s` は、ポッド、サービス、デプロイメント、またはステートフルセットへの管理されたポートフォワードを開きます:```http
### Service health
# @k8s namespace=default service=api port=http
GET http://api.default.svc.cluster.local/health