codecommit-github-migrator (cgm)

This tool helps to migrate repositories from CodeCommit with all open PullRequests to GitHub.

• codecommit-github-migrator (cgm)
• Usage
• Commands

Usage

Prepare

As prerequisitory you should have git installed and configured.

You should also have already created the target GitHub repository manually.

Additionally you will also need AWS and GitHub Access Token. They can be read automatically from your ENV variables. If you don't provide any auth flags AWS will fallback to your .aws/credentials and .aws/config file. If you don't provide a GitHub Token the tool tries to get the token from the gh-CLI (gh auth token)

Install cgm

$ npm install -g codecommit-github-migrator
$ cgm COMMAND
running command...
$ cgm (--version)
codecommit-github-migrator/0.2.6 darwin-arm64 node-v18.16.0
$ cgm --help [COMMAND]
USAGE
  $ cgm COMMAND
...

Commands

• cgm help [COMMANDS]
• cgm migrate

cgm help [COMMANDS]

Display help for cgm.

USAGE
  $ cgm help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for cgm.

See code: @oclif/plugin-help

cgm migrate

Migrates a CodeCommit Repo to GitHub

USAGE
  $ cgm migrate [-c <value>] [-g <value>] [-j <value>] [-b | -M] [-h] [--awsRegion <value>]
    [--awsSessionToken <value> [--awsAccessKeyId <value> --awsSecretAccessKey <value>] ] [--awsProfile <value>]
    [--ghToken <value>]

FLAGS
  -c, --ccRepo=codecommit://REPO                url of the migration source CodeCommit repo
  -g, --ghRepo=https://github.com/ORG/REPO      url of the migration target GitHub repo
  -j, --jiraBase=https://ACCOUNT.atlassian.net  baseurl of jira

GIT FLAGS
  -M, --noMirror        set if you do not like to mirror the codecommit repo automatically
  -b, --bigFileCleanup  set if you like/need a `bfg` cleanup of big files over 100MB.
                        Can not used together with `--noMirror, -M` flag

HELP FLAGS
  -h, --help  Show CLI help.

AWS FLAGS
  --awsAccessKeyId=<value>      AWS Access Key Id can also be set through AWS_ACCESS_KEY_ID env
  --awsProfile=<value>          AWS Profile to use for credentials can also be set through AWS_PROFILE env
                                If awsProfile flag is provided, the profile will be used instead of `awsAccessKeyId` and
                                `awsSecretAccessKey`
  --awsRegion=<value>           [default: eu-central-1] AWS Region can also be set through AWS_REGION env
  --awsSecretAccessKey=<value>  AWS Secret Access Key can also be set through AWS_SECRET_ACCESS_KEY env
  --awsSessionToken=<value>     AWS Session Token can also be set through AWS_SESSION_TOKEN env

GITHUB FLAGS
  --ghToken=<value>  GitHub Token can also be set through GITHUB_TOKEN env

DESCRIPTION
  Migrates a CodeCommit Repo to GitHub

EXAMPLES
  $ cgm migrate

  $ cgm migrate -M

  $ cgm migrate -b

  $ cgm migrate -c codecommit://REPO -g https://github.com/ORG/REPO -j https://ACCOUNT.atlassian.net

  $ cgm migrate -h

See code: dist/commands/migrate.ts