Github Copilot CLI

This repository contains GHCCLI, an enhanced command-line AI workflow tool that connects to your tools, understands your code and accelerates your workflows. GHCCLI is built on top of the Gemini CLI with additional customizations and features.

With GHCCLI you can:

• Query and edit large codebases.
• Generate new apps from PDFs or sketches, using multimodal AI capabilities.
• Automate operational tasks, like querying pull requests or handling complex rebases.
• Use tools and MCP servers to connect new capabilities, including media generation tools
• Ground your queries with integrated search capabilities.
• Access multiple AI providers including Gemini, GitHub Copilot, and OpenAI.

Quickstart

You have multiple options to install GHCCLI.

With Node

1. Prerequisites: Ensure you have Node.js version 20 or higher installed.

2. Install from source: Clone and build the CLI:

   git clone https://github.com/plusplusoneplusplus/ghccli.git
   cd ghccli
   npm install
   npm run build

   Then, run the CLI from the project directory:

   npm start

   Or install it globally:

   npm install -g .
   ghccli

Alternative Installation Methods

With Homebrew (if available)

1. Prerequisites: Ensure you have Homebrew installed.

2. Install the CLI: Execute the following command in your terminal:

   brew install ghccli

   Then, run the CLI from anywhere:

   ghccli

With NPX (upstream Gemini CLI)

For the original Gemini CLI functionality:

npx https://github.com/google-gemini/gemini-cli

Common Configuration steps

3. Pick a color theme
4. Authenticate: When prompted, choose your preferred AI provider and sign in. GHCCLI supports multiple authentication methods including Google accounts, GitHub Copilot, and OpenAI.

You are now ready to use GHCCLI!

Use a Gemini API key:

The Gemini API provides a free tier with 100 requests per day using Gemini 2.5 Pro, control over which model you use, and access to higher rate limits (with a paid plan):

1. Generate a key from Google AI Studio.

2. Set it as an environment variable in your terminal. Replace YOUR_API_KEY with your generated key.

   export GEMINI_API_KEY="YOUR_API_KEY"

3. (Optionally) Upgrade your Gemini API project to a paid plan on the API key page (will automatically unlock Tier 1 rate limits)

Use a Vertex AI API key:

The Vertex AI API provides a free tier using express mode for Gemini 2.5 Pro, control over which model you use, and access to higher rate limits with a billing account:

1. Generate a key from Google Cloud.

2. Set it as an environment variable in your terminal. Replace YOUR_API_KEY with your generated key and set GOOGLE_GENAI_USE_VERTEXAI to true

   export GOOGLE_API_KEY="YOUR_API_KEY"
   export GOOGLE_GENAI_USE_VERTEXAI=true

3. (Optionally) Add a billing account on your project to get access to higher usage limits

Use GitHub Copilot:

The GitHub Copilot integration provides access to GPT-4 and other models through your GitHub Copilot subscription:

1. Prerequisites: You need an active GitHub Copilot subscription (individual, business, or enterprise).

2. Authentication: The CLI will guide you through GitHub's OAuth flow:

   • Just select "GitHub Copilot" in the authentication menu
   • The CLI will display a device code and verification URL
   • Visit the URL and enter the code to authorize

Use OpenAI directly:

Connect directly to OpenAI's API or OpenAI-compatible APIs:

1. Prerequisites: You need an OpenAI API key from your OpenAI account.

2. Configuration: Set the required environment variables:

   # Required: Your OpenAI API key
   export OPENAI_API_KEY="sk-your-openai-api-key"
   
   # Optional: Custom base URL (defaults to OpenAI)
   export OPENAI_BASE_URL="https://api.openai.com/v1"
   
   # Optional: Default model (defaults to gpt-4o)
   export OPENAI_MODEL="gpt-4"

3. Authentication: Select "OpenAI" in the authentication menu when starting the CLI.

For other authentication methods, including Google Workspace accounts, see the authentication guide.

Examples

Once the CLI is running, you can start interacting with AI from your shell.

You can start a project from a new directory:

cd new-project/
ghccli
> Write me a Discord bot that answers questions using a FAQ.md file I will provide

Or work with an existing project:

git clone https://github.com/plusplusoneplusplus/ghccli
cd ghccli
ghccli
> Give me a summary of all of the changes that went in yesterday

Next steps

• Learn how to contribute to or build from the source.
• Explore the available CLI Commands.
• If you encounter any issues, review the troubleshooting guide.
• For more comprehensive documentation, see the full documentation.
• Take a look at some popular tasks for more inspiration.
• Check out our Official Roadmap

Troubleshooting

Head over to the troubleshooting guide if you're having issues.

Popular tasks

Explore a new codebase

Start by cding into an existing or newly-cloned repository and running ghccli.

> Describe the main pieces of this system's architecture.

> What security mechanisms are in place?

> Provide a step-by-step dev onboarding doc for developers new to the codebase.

> Summarize this codebase and highlight the most interesting patterns or techniques I could learn from.

> Identify potential areas for improvement or refactoring in this codebase, highlighting parts that appear fragile, complex, or hard to maintain.

> Which parts of this codebase might be challenging to scale or debug?

> Generate a README section for the [module name] module explaining what it does and how to use it.

> What kind of error handling and logging strategies does the project use?

> Which tools, libraries, and dependencies are used in this project?

Work with your existing code

> Implement a first draft for GitHub issue #123.

> Help me migrate this codebase to the latest version of Java. Start with a plan.

Automate your workflows

Use MCP servers to integrate your local system tools with your enterprise collaboration suite.

> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member.

> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues.

Interact with your system

> Convert all the images in this directory to png, and rename them to use dates from the exif data.

> Organize my PDF invoices by month of expenditure.

Uninstall

Head over to the Uninstall guide for uninstallation instructions.

Terms of Service and Privacy Notice

For details on the terms of service and privacy notice applicable to your use of GHCCLI, see the Terms of Service and Privacy Notice.

Security Disclosures

Please see our security disclosure process. All security advisories are managed on Github.

Acknowledgments

GHCCLI is built on top of the excellent Gemini CLI project by Google. We extend our gratitude to the original authors and contributors.