# 機能設計書 57-外部コマンド実行

## 概要

本ドキュメントは、Nushellにおける外部コマンド実行機能の設計仕様を記載する。この機能は、^（キャレット）プレフィックスによる外部コマンド実行と、completeコマンドによる実行結果のキャプチャを提供する。

### 本機能の処理概要

外部コマンド実行機能は、システムにインストールされた外部プログラムをNushellから実行し、その入出力をパイプラインと統合する。

**業務上の目的・背景**：Nushellは独自のコマンド体系を持つが、既存のシステムコマンドやサードパーティツールとの連携が必要である。シームレスな外部コマンド実行により、既存のワークフローを維持しながらNushellの構造化データ処理の恩恵を受けられる。

**機能の利用シーン**：
- gitなどのバージョン管理コマンドの実行
- Docker、kubectl等の運用ツールの実行
- コンパイラ、ビルドツールの呼び出し
- システム管理コマンドの実行
- Nushellに組み込まれていないコマンドの利用

**主要な処理内容**：
1. コマンド名の解決（PATH検索、拡張子解決）
2. 環境変数の継承とプロセス生成
3. 標準入出力のパイプライン接続
4. 終了コードのハンドリング

**関連システム・外部連携**：
- オペレーティングシステムのプロセス管理
- PATH環境変数に登録されたコマンド
- シェル（Windows: cmd.exe、PowerShell）

**権限による制御**：実行するコマンドの権限要件に依存

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインREPL | API連携 | 外部コマンド（^）の実行とパイプライン連携 |

## 機能種別

プロセス実行 / パイプライン統合

## 入力仕様

### 入力パラメータ

#### run-external（内部コマンド）

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| command | GlobPattern/Any (rest) | Yes | 外部コマンドと引数 | 最低1つのコマンド名 |

#### complete

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (パイプライン入力) | ByteStream | Yes | 外部コマンドの出力 | 外部コマンドからの入力のみ |

### 入力データソース

コマンドライン引数、パイプライン入力

## 出力仕様

### 出力データ

#### run-external

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (出力) | ByteStream | 外部コマンドの標準出力 |

#### complete

| 項目名 | 型 | 説明 |
|--------|-----|------|
| stdout | String/Binary | 標準出力の内容 |
| stderr | String/Binary | 標準エラー出力の内容 |
| exit_code | Int | 終了コード |

### 出力先

パイプライン出力

## 処理フロー

### 処理シーケンス（run-external）

```
1. コマンド名解決
   └─ which()でPATH検索、拡張子解決
2. 環境変数準備
   └─ env_to_strings()で環境変数を文字列マップに変換
3. プロセス設定
   └─ 標準入出力の接続設定
4. プロセス生成
   └─ ForegroundChild::spawn()でプロセス起動
5. 入力転送
   └─ パイプライン入力を子プロセスのstdinに転送
6. 出力返却
   └─ ByteStreamとしてstdoutを返却
```

### 処理シーケンス（complete）

```
1. 入力検証
   └─ ByteStreamかつ外部コマンドからの入力を確認
2. プロセス待機
   └─ wait_with_output()で終了と出力取得
3. レコード構築
   └─ stdout, stderr, exit_codeを含むレコード作成
4. 結果返却
   └─ Recordとして返却
```

### フローチャート

```mermaid
flowchart TD
    A[^external実行] --> B[コマンド名抽出]
    B --> C{コマンド発見?}
    C -->|No| D[command_not_found]
    C -->|Yes| E[環境変数準備]
    E --> F[プロセス設定]
    F --> G{入力あり?}
    G -->|Yes| H[stdin接続]
    G -->|No| I[stdinを継承/null]
    H --> J[プロセス起動]
    I --> J
    J --> K[ByteStream返却]

    L[complete実行] --> M{ByteStream入力?}
    M -->|No| N[エラー: 外部コマンドのみ対応]
    M -->|Yes| O[プロセス終了待機]
    O --> P[stdout/stderr取得]
    P --> Q[exit_code取得]
    Q --> R[Record構築]
    R --> S[結果返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | PATH検索 | コマンドをPATHから検索 | 絶対パスでない場合 |
| BR-02 | Windows CMD内部コマンド | ASSOC, CLS等はcmd.exe経由で実行 | Windows環境 |
| BR-03 | PowerShellスクリプト | .ps1ファイルはpowershell.exe経由 | Windows環境 |
| BR-04 | グロブ展開 | 引数のグロブパターンを展開 | no_expand=false時 |
| BR-05 | バックグラウンドジョブstdin | バックグラウンドジョブはstdinをnull | is_background_job()時 |

### 計算ロジック

特になし

## データベース操作仕様

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ExternalCommand | 実行エラー | コマンドが見つからない | PATHと権限を確認 |
| MissingParameter | 引数エラー | コマンド名未指定 | コマンド名を指定 |
| GenericError | 実行エラー | completeで外部コマンド以外に使用 | 外部コマンドに対して使用 |
| RemovedCommand | 互換性エラー | 廃止されたコマンド名 | 代替コマンドを使用 |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

- プロセス起動のオーバーヘッドは最小限
- 大量データの入出力はストリーミング処理

## セキュリティ考慮事項

- 外部コマンドは現在のユーザー権限で実行
- 引数のエスケープはOSに依存（特にWindows cmd.exe）
- command_not_foundフックでの無限ループ防止

## 備考

- `run-external`は内部コマンドで、通常は`^`プレフィックスで呼び出し
- Windowsでは拡張子解決やPATHEXT対応あり

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | run_external.rs | `crates/nu-command/src/system/run_external.rs` | コマンドシグネチャと引数処理 |

**読解のコツ**:
- **41-49行目**: シグネチャでrestとしてコマンドと引数を受け取る
- **154-167行目**: Arguments構造体の定義

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | run_external.rs | `crates/nu-command/src/system/run_external.rs` | run()メソッドとコマンド解決 |
| 2-2 | complete.rs | `crates/nu-command/src/system/complete.rs` | completeコマンドの実装 |

**主要処理フロー（run_external.rs）**:
- **52-58行目**: run()でコマンドと引数を取得
- **70-85行目**: コマンド名の抽出（List対応含む）
- **110-169行目**: Windows特有のコマンド解決（CMD内部コマンド、PowerShellスクリプト）
- **171-175行目**: std::process::Commandの構築
- **177-180行目**: 環境変数の設定
- **282-290行目**: ForegroundChild::spawn()でプロセス起動

**主要処理フロー（complete.rs）**:
- **34-44行目**: ByteStream入力からchildプロセス取得
- **52行目**: wait_with_output()で終了待機
- **56-76行目**: stdout/stderr/exit_codeのRecord構築

#### Step 3: コマンド検索を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | run_external.rs | `crates/nu-command/src/system/run_external.rs` | which()とcommand_not_found() |

**主要処理フロー**:
- **678-681行目**: which()でPATH検索
- **533-667行目**: command_not_found()でエラー処理とサジェスト

#### Step 4: 入出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | run_external.rs | `crates/nu-command/src/system/run_external.rs` | stdin/stdout/stderrの接続 |

**主要処理フロー**:
- **205-241行目**: stdout/stderrの設定（マージストリーム含む）
- **246-274行目**: stdin接続（パイプライン、直接接続、継承）
- **308-326行目**: stdin転送用のワーカースレッド

### プログラム呼び出し階層図

```
^external または run-external
    │
    ├─ run()
    │      │
    │      ├─ コマンド名抽出
    │      │      └─ Value::Glob/String/List対応
    │      │
    │      ├─ which()
    │      │      └─ PATH検索
    │      │
    │      ├─ [Windows] is_cmd_internal_command() / .ps1チェック
    │      │
    │      ├─ std::process::Command構築
    │      │      ├─ current_dir()
    │      │      ├─ env_clear() + envs()
    │      │      ├─ args()
    │      │      ├─ stdout() / stderr()
    │      │      └─ stdin()
    │      │
    │      ├─ ForegroundChild::spawn()
    │      │
    │      ├─ [入力あり] スレッドでstdin転送
    │      │
    │      └─ PipelineData::byte_stream()
    │
    └─ command_not_found()
           ├─ command_not_foundフック実行
           ├─ 廃止コマンドチェック
           ├─ モジュールサジェスト
           └─ ファジーマッチサジェスト

complete
    │
    └─ run()
           │
           ├─ ByteStream → ChildProcess取得
           │
           ├─ wait_with_output()
           │
           └─ Record { stdout, stderr, exit_code }
```

### データフロー図

```
[入力]                    [処理]                         [出力]

コマンド + 引数 ─────────▶ run-external ────────────────▶ ByteStream (stdout)
パイプライン入力 ─────────▶ stdin転送

ByteStream ─────────────▶ complete ─────────────────────▶ Record
(外部コマンド出力)        wait_with_output()              { stdout, stderr, exit_code }
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| run_external.rs | `crates/nu-command/src/system/run_external.rs` | ソース | run-externalコマンドの実装 |
| complete.rs | `crates/nu-command/src/system/complete.rs` | ソース | completeコマンドの実装 |
| nu-system | `crates/nu-system/` | クレート | ForegroundChildなどのプロセス管理 |
