Skip to main content

Enterprise Live Migrations CLI reference

Detailed usage information for the ELM CLI tool.

Note

Enterprise Live Migrations is in public preview and subject to change.

elm migration commands

CommandDescription
elm migration createCreates a new migration for a single source repository
elm migration start --migration-id MIGRATION-IDStarts a migration
elm migration status --migration-id MIGRATION-IDShows the status, progress, cutover readiness, and timing of a migration
elm migration listLists all migrations and their statuses
elm migration cancel --migration-id MIGRATION-IDCancels a migration in progress
elm migration cutover-to-destination --migration-id MIGRATION-IDInitiates the final cutover, archiving the source repository and completing the migration

Some of these commands can take additional options. See the later sections in this article.

elm migration create options

Create a new migration to prepare for repository export and import.

FlagRequiredDefaultDescription
--source-orgYesN/ASlug of the source organization on GitHub Enterprise Server
--source-repoYesN/AName of the source repository
--target-orgYesN/ASlug of the destination organization on GHE.com
--target-repoYesN/AName of the destination repository
--target-apiYesN/AThe API URL for your destination enterprise (for example: https://api.octocorp.ghe.com). Do not include a trailing slash at the end of the URL.
--pat-nameYesN/AThis must be set to a static string: system-pat
--target-visibilityNointernalVisibility of the destination repository. Must be private or internal. Public repositories are not supported.
--startNofalseAutomatically starts the migration after creating it

elm migration list options

FlagRequiredDefaultDescription
--statusNoN/AFilters results by migration status. Valid values: created, queued, in_progress, paused, completed, failed, terminated.