https://github.com/timrogers/github-migration-monitor

Monitors GitHub Enterprise Importer (GEI) migrations for an organization through a simple command line tool
https://github.com/timrogers/github-migration-monitor

Last synced: 28 days ago
JSON representation

Monitors GitHub Enterprise Importer (GEI) migrations for an organization through a simple command line tool

• Host: GitHub
• URL: https://github.com/timrogers/github-migration-monitor
• Owner: timrogers
• License: mit
• Created: 2023-04-21T12:00:21.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T10:32:58.000Z (about 2 months ago)
• Last Synced: 2024-12-15T02:32:04.612Z (about 1 month ago)
• Language: JavaScript
• Size: 665 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# GitHub Migration Monitor

This command line tool allows you to monitor an organization's [GitHub Enterprise Importer (GEI)](https://docs.github.com/en/migrations/using-github-enterprise-importer) migrations.

It'll watch your organization's migrations and display a UI with your queued, in progress, successful and failed migrations, plus an event log.

## Usage

1. Make sure you have [Node.js](https://nodejs.org/) installed. You can double check by running `node --version`.

2. Make sure you have [npm](https://npmjs.com) installed. You can double check by running `npm --version`.

3. Set the `GITHUB_TOKEN` environment variable to a classic personal access token (PAT) with the `admin:org` scope.

4. Run `npx github-migration-monitor --organization ORGANIZATION`, replacing `ORGANIZATION` with your organization name.

### Customizing how often the CLI polls for updates

By default, the CLI will poll for updates to your migrations every 10 seconds.

You can customize this by setting the `--interval-in-seconds` argument with a value in seconds.

### Setting the GitHub token using a command line argument

Instead of specifying your access token using the `GITHUB_TOKEN` environment variable, you can alternatively use the `--github-token` argument