# Referência da CLI do Enterprise Live Migrations

Informações detalhadas de uso da ferramenta da ELM CLI.

>[!NOTE] 
Enterprise Live Migrations está dentro prévia pública e sujeito a alterações.

## `elm migration` comandos

| Comando | Descrição |
|---|---|
| `elm migration create` | Cria uma nova migração para um único repositório de origem |
| `elm migration start --migration-id MIGRATION-ID` | Inicia uma migração |
| `elm migration status --migration-id MIGRATION-ID` | Mostra o status, o progresso, a prontidão para transição e o cronograma de uma migração |
| `elm migration list` | Lista todas as migrações e seus status |
| `elm migration cancel --migration-id MIGRATION-ID` | Cancela uma migração em andamento |
| `elm migration cutover-to-destination --migration-id MIGRATION-ID` | Inicia a substituição final, arquivando o repositório de origem e concluindo a migração |

Alguns desses comandos podem ter opções adicionais. Consulte as seções posteriores neste artigo.

## `elm migration create` opções

Crie uma nova migração para se preparar para exportação e importação de repositório.

| Flag | Obrigatório | Default | Descrição |
|---|---|---|---|
| `--source-org` | Yes | N/A | Slug da organização de origem em GitHub Enterprise Server |
| `--source-repo` | Yes | N/A | Nome do repositório de origem |
| `--target-org` | Yes | N/A | Lesma da organização de destino em GHE.com |
| `--target-repo` | Yes | N/A | Nome do repositório de destino |
| `--target-api` | Yes | N/A | A URL da API para sua empresa de destino (por exemplo: `https://api.octocorp.ghe.com`). 
**Não** inclua uma barra no final da URL. |
| `--pat-name` | Yes | N/A | Isso deve ser definido como uma cadeia de caracteres estática: `system-pat` |
| `--target-visibility` | Não | `internal` | Visibilidade do repositório de destino. Deve ser `private` ou `internal`. Não há suporte para repositórios públicos. |
| `--start` | Não | `false` | Inicia automaticamente a migração depois de criá-la |

## `elm migration list` opções

| Flag | Obrigatório | Default | Descrição |
|---|---|---|---|
| `--status` | Não | N/A | Filtra os resultados por status de migração. Valores válidos: `created`, , `queued`, `in_progress`, `paused`, `completed`, , `failed`, `terminated`. |
| `--page-size` | Não | N/A | Número de resultados por página |
| `--after` | Não | N/A | Cursor de paginação, de uma resposta anterior |

## `elm migration cutover-to-destination` opções

| Flag | Obrigatório | Default | Descrição |
|---|---|---|---|
| `--migration-id` | Yes | N/A | A ID de uma migração pronta para substituição. |
| `--force` | Não | `false` | Por padrão, o comando verifica se o alvo da migração indica prontidão antes de continuar. Use `--force` para ignorar essa verificação quando tiver certeza de que o estado de migração está correto. |

## Sinalizadores e variáveis globais

As propriedades a seguir podem ser fornecidas como variáveis de ambiente ou como sinalizadores em qualquer comando, com sinalizadores de comando tendo prioridade. Você deve definir esses valores _depois_ de aplicar a `ghe-config` configuração.

| Variable | Flag | Obrigatório | Descrição |
|----------|------|----------|-------------|
| API_URL | `--api-url` | Yes | Deve ser definido como `http://localhost:1738`. |
| MIGRATION_MANAGER_HMAC_KEY | `--migration-manager-hmac-key` | Yes | Deve ser definido como `$(ghe-config secrets.elm-exporter.elm-exporter-hmac-keys)`. |
| MIGRATION_TARGET_URL | `--migration-target-url` | Yes | A URL da API para sua empresa de destino (por exemplo: `https://api.octocorp.ghe.com`). 
**Não** inclua uma barra no final da URL. |
| MIGRATION_TARGET_TOKEN | `--migration-target-token` | Yes | O personal access token (classic) para GHE.com |
| DEBUG_HTTP | `--debug-http` | Não | Defina para `true` para imprimir o método HTTP, a URL, os cabeçalhos e o corpo da resposta de erro de cada solicitação, para fins de depuração. |