Enterprise Live Migrations CLI reference - GitHub Docs
https://docs.github.com/en/migrations/elm/elm-cli-reference • 171 KB fetched Open original page
Enterprise Live Migrations CLI reference - GitHub Docs Skip to main content
GitHub Docs Version: Free, Pro, & Team
Search or ask Copilot Search or ask Copilot
Select language: current language is English
Search or ask Copilot Search or ask Copilot
Open menu
Collapse sidebar Expand sidebar
Scroll breadcrumbs left
* Home
* Migrations
* Live migrations (GHES to GHE.com)
* ELM CLI reference
Scroll breadcrumbs right
Migrations
*
*
* Overview
* GitHub's migration tooling
* Migrations within GitHub
* Plan your migration
* Migration paths
* Locked repositories
* Mannequins and user activity
* Programmatic repository imports
* Migrate from Azure DevOps
* Get started
* 1. Understand migrations
* 2. Manage access
* 3. Configure GitHub Enterprise Importer
* 4. Prepare to migrate
* 5. Migrate repositories
* 6. Follow-up tasks
* Key differences
* Migrate with GraphQL API
* Migrator role
* Import source code
* GitHub Importer
* About GitHub Importer
* Import a repository
* Command line
* About source code imports
* Local code
* External Git repo
* Subversion
* Mercurial
* Team Foundation Version Control
* GitHub Enterprise Importer
* Understand GitHub Enterprise Importer
* About GitHub Enterprise Importer
* Migrate from Bitbucket Server
* About migrations
* Overview of a migration
* Manage access
* Migrate repositories
* Migrate between GitHub products
* About migrations
* Overview of a migration
* Manage access
* Migrate from Enterprise Server
* Migrate repositories from GitHub.com
* Migrate organizations from GitHub.com
* Migrate from GitLab
* Get started
* 1. Understand migrations
* 2. Plan your migration
* 3. Manage access
* 4. Configure GitHub Enterprise Importer
* 5. Configure storage
* 6. Migrate repositories
* 7. Follow-up tasks
* Migrate with GraphQL API
* Migrator role
* Complete migration
* Access migration logs
* Reclaim mannequins
* Live migrations (GHES to GHE.com)
* About live migrations
* Prepare for your migration
* Migrate your repository
* Complete your migration
* Troubleshooting
* Migrated data reference
* ELM CLI reference
* ghe-migrator
* About ghe-migrator
* Export from GHES
* Export from GitHub.com
* Migrate data
* Troubleshoot migrations
* Troubleshoot migrations
Enterprise Live Migrations CLI reference
Detailed usage information for the ELM CLI tool.
Copy as Markdown
In this article
* Installation
* Setup commands
* Migration commands
* Target commands
* gh elm migration create options
* gh elm migration list options
* gh elm migration cutover options
Installation
gh extension install github/gh-elm
The extension requires GitHub CLI ( gh ) version 2.0 or later.
Setup commands
Command Description
gh elm config Interactively configure the endpoints and tokens for ELM use
gh elm config reset Remove stored configuration and credentials
gh elm config show Show the current configuration, with tokens redacted
gh elm completion Generate a shell autocompletion script for the specified shell
Migration commands
Command Description
gh elm migration list List migrations
gh elm migration create Create a new migration
gh elm migration start MIGRATION-ID Start a previously created migration
gh elm migration status MIGRATION-ID Get the status and details of a migration
gh elm migration watch MIGRATION-ID Watch migration progress with a live-updating display
gh elm migration pause MIGRATION-ID Pause a running migration
gh elm migration resume MIGRATION-ID Resume a paused migration
gh elm migration cancel MIGRATION-ID Cancel and terminate a migration
gh elm migration target-id MIGRATION-ID Look up the target (destination) migration ID for a migration
gh elm migration cutover MIGRATION-ID Initiate a cutover to the destination for a migration
gh elm migration cutover status MIGRATION-ID Get the cutover status and progress for a migration
gh elm migration cutover revert MIGRATION-ID Revert the effects of a cutover so the source repository can be migrated again
Some of these commands can take additional options. See the later sections in this article.
Target commands
Command Description
gh elm target mannequin reclaim Claim (reclaim) one or more mannequins on the target organization
gh elm target mannequin list List a target organization's mannequins as CSV
gh elm target report request Request a node report for a migration
gh elm target report status Query the status of a migration's node report
gh elm target report url Get a signed download URL for a finished report
gh elm target resources List a migration's resources from the target
gh elm migration create options
Create a new migration to prepare for repository export and import.
Flag Required Default Description
--source-org Yes N/A Slug of the source organization on GitHub Enterprise Server
--source-repo Yes N/A Name of the source repository
--target-org Yes N/A Slug of the destination organization on GHE.com
--target-repo Yes N/A Name of the destination repository
--target-visibility No internal Visibility of the destination repository. Must be private or internal . Public repositories are not supported.
--start No false Automatically starts the migration after creating it
--json No false Output the API's raw JSON response instead of human-readable text
gh elm migration list options
Flag Required Default Description
--status No N/A Filters results by migration status. Valid values: created , queued , in_progress , paused , completed , failed , terminated .
--page-size No N/A Number of results per page
--after No N/A Cursor for pagination, from a previous response
--json No false Output the API's raw JSON response instead of human-readable text
gh elm migration cutover options
Flag Required Default Description
--migration-id Yes N/A The ID of a migration that is ready for cutover.
--force No false By default, the command checks whether the migration target reports readiness before proceeding. Use --force to bypass this check when you are certain the migration state is correct.
--watch No false After triggering cutover, enter live watch mode
Back to top
Help and support
Was this Doc helpful?
Yes No
Help us make GitHub Docs great!
All Docs are open source. See something that's wrong or unclear? Submit a pull request.
Make a contribution
Still need help?
Ask the GitHub community Contact support Expert services Blog
GitHub Inc. © 2026 Terms Privacy Status Pricing
Links found on this page
- Skip to main content [direct]
- GitHub Docs [direct]
- Migrations [direct]
- Live migrations (GHES to GHE.com) [direct]
- GitHub's migration tooling [direct]
- Migrations within GitHub [direct]
- Plan your migration [direct]
- Migration paths [direct]
- Locked repositories [direct]
- Mannequins and user activity [direct]
- Programmatic repository imports [direct]
- Get started [direct]
- 1. Understand migrations [direct]
- 2. Manage access [direct]
- 3. Configure GitHub Enterprise Importer [direct]
- 4. Prepare to migrate [direct]
- 5. Migrate repositories [direct]
- 6. Follow-up tasks [direct]
- Key differences [direct]
- Migrate with GraphQL API [direct]
- Migrator role [direct]
- About GitHub Importer [direct]
- Import a repository [direct]
- About source code imports [direct]
- Local code [direct]
- External Git repo [direct]
- Subversion [direct]
- Mercurial [direct]
- Team Foundation Version Control [direct]
- About GitHub Enterprise Importer [direct]
- About migrations [direct]
- Overview of a migration [direct]
- Manage access [direct]
- Migrate repositories [direct]
- About migrations [direct]
- Overview of a migration [direct]
- Manage access [direct]
- Migrate from Enterprise Server [direct]
- Migrate repositories from GitHub.com [direct]
- Migrate organizations from GitHub.com [direct]
- Get started [direct]
- 1. Understand migrations [direct]
- 2. Plan your migration [direct]
- 3. Manage access [direct]
- 4. Configure GitHub Enterprise Importer [direct]
- 5. Configure storage [direct]
- 6. Migrate repositories [direct]
- 7. Follow-up tasks [direct]
- Migrate with GraphQL API [direct]
- Migrator role [direct]
- Access migration logs [direct]
- Reclaim mannequins [direct]
- About live migrations [direct]
- Prepare for your migration [direct]
- Migrate your repository [direct]
- Complete your migration [direct]
- Troubleshooting [direct]
- Migrated data reference [direct]
- About ghe-migrator [direct]
- Export from GHES [direct]
- Export from GitHub.com [direct]
- Migrate data [direct]
- Troubleshoot migrations [direct]
- Make a contribution [direct]
- Ask the GitHub community [direct]
- Contact support [direct]
- Expert services [direct]
- Blog [direct]
- Terms [direct]
- Privacy [direct]
- Status [direct]
- Pricing [direct]
|
|