# Enterprise Live Migrations コマンドラインインターフェース リファレンス

ELM CLI ツールの詳細な使用状況情報。

## Installation

```shell
gh extension install github/gh-elm
```

拡張機能には、 GitHub CLI (`gh`) バージョン 2.0 以降が必要です。

## セットアップ コマンド

| 命令               | Description                                                    |
|-----------------------|----------------------------------------------------------------|
| `gh elm config`       | ELM で使用するエンドポイントとトークンを対話形式で構成する   |
| `gh elm config reset` | 保存されている構成と資格情報を削除する                    |
| `gh elm config show`  | トークンが編集された状態で現在の構成を表示する           |
| `gh elm completion`   | 指定したシェルのシェルオートコンプリート スクリプトを生成する |

## 移行コマンド

| 命令 | Description |
|---|---|
| `gh elm migration list` | 移行を一覧表示する |
| `gh elm migration create` | 新しい移行を作成する |
| `gh elm migration start MIGRATION-ID` | 以前に作成した移行を開始する |
| `gh elm migration status MIGRATION-ID` | 移行の状態と詳細を取得する |
| `gh elm migration watch MIGRATION-ID` | ライブ更新の表示で移行の進行状況を監視する |
| `gh elm migration pause MIGRATION-ID` | 実行中の移行を一時停止する |
| `gh elm migration resume MIGRATION-ID` | 一時停止した移行を再開する |
| `gh elm migration cancel MIGRATION-ID` | 移行を取り消して終了する |
| `gh elm migration target-id MIGRATION-ID` | 移行のターゲット (移行先) 移行 ID を検索する |
| `gh elm migration cutover MIGRATION-ID` | 移行先へのカットオーバーを開始する |
| `gh elm migration cutover status MIGRATION-ID` | 移行の切り替えの状態と進捗を取得する |
| `gh elm migration cutover revert MIGRATION-ID` | ソース リポジトリを再度移行できるように、カットオーバーの効果を元に戻す |

これらのコマンドの一部では、追加のオプションを使用できます。 この記事の後のセクションを参照してください。

## ターゲット コマンド

| 命令 | Description |
| ------- | ----------- |
| `gh elm target mannequin reclaim` | ターゲット組織の 1 つ以上のマネキンを要求 (回収) する |
| `gh elm target mannequin list` | ターゲット組織のマネキンを CSV として一覧表示する |
| `gh elm target report request` | 移行のノード レポートを要求する |
| `gh elm target report status` | 移行のノード レポートの状態を照会する |
| `gh elm target report url` | 完成したレポートの署名付きダウンロード URL を取得する |
| `gh elm target resources` | 移行のリソースをターゲットから一覧表示する |
  
## `gh elm migration create` のオプション

リポジトリのエクスポートとインポートを準備するための新しい移行を作成します。

| Flag                  | Required | Default    | Description                                                                                                       |
|-----------------------|----------|------------|-------------------------------------------------------------------------------------------------------------------|
| `--source-org`        | Yes      | N/A        | ソース組織のスラッグ GitHub Enterprise Server                               |
| `--source-repo`       | Yes      | N/A        | ソース リポジトリの名前                                                                                     |
| `--target-org`        | Yes      | N/A        | 宛先組織のスラッグ GHE.com                       |
| `--target-repo`       | Yes      | N/A        | 宛先リポジトリの名前                                                                                |
| `--target-visibility` | No       | `internal` | 宛先リポジトリの可視性。 
`private` または `internal` である必要があります。 パブリック リポジトリはサポートされていません。 |
| `--start`             | No       | `false`    | 作成後に移行を自動的に開始する                                                              |
| `--json`              | No       | `false`    | 人間が判読できるテキストではなく、API の生の JSON 応答を出力する                                                |

## `gh elm migration list` のオプション

| Flag          | Required | Default | Description                                                                                                                           |
|---------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------|
| `--status`    | No       | N/A     | 移行ステータスで結果をフィルターする。 有効な値: `created`、 `queued`、 `in_progress`、 `paused`、 `completed`、 `failed`、 `terminated`。 |
| `--page-size` | No       | N/A     | 1 ページあたりの結果の数                                                                                                            |
| `--after`     | No       | N/A     | 前の応答からのページネーションのカーソル                                                                                       |
| `--json`      | No       | `false` | 人間が判読できるテキストではなく、API の生の JSON 応答を出力する                                                                    |

## `gh elm migration cutover` のオプション

| Flag             | Required | Default | Description                                                                                                                                                                              |
|------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--migration-id` | Yes      | N/A     | カットオーバーの準備ができている移行の ID。                                                                                                                                         |
| `--force`        | No       | `false` | 既定では、このコマンドは、移行先が準備状況を報告するかどうかを確認してから続行します。 移行状態が正しいと確信している場合は、 `--force` を使用してこのチェックをバイパスします。 |
| `--watch`        | No       | `false` | カットオーバーをトリガーした後、ライブ ウォッチ モードに入ります                                                                                                                                         |