Skip to content

Installation

Prerequisites

Before installing GitHub Extractor CLI, you need to have the following installed:

  1. Node.js (version 18 or higher)
  2. GitHub CLI (gh)

Installing Node.js

Download and install Node.js from nodejs.org. Make sure to install version 18 or higher.

Installing GitHub CLI

Follow the official installation guide for your platform:

After installing GitHub CLI, authenticate with your GitHub account:

bash
gh auth login

Installing GitHub Extractor CLI

Install the tool globally using npm:

bash
npm install -g ghextractor

Local Installation

You can also install it locally in a project:

bash
npm install ghextractor

Verifying Installation

Check that the tool is installed correctly:

bash
ghextractor --version

You can also check your GitHub CLI setup:

bash
ghextractor --check

This will verify that GitHub CLI is installed and you're authenticated.

Released under the MIT License.