Skip to content

JetBrains plugin to run GitHub Copilot CLI (copilot) in an embedded terminal

License

Notifications You must be signed in to change notification settings

mosesnagar/copilot-cli-jetbrains

Repository files navigation

Copilot CLI Terminal - JetBrains Plugin

Copilot CLI Logo

Run GitHub Copilot CLI (copilot) seamlessly inside IntelliJ-based IDEs. No more switching to external terminals.

JetBrains Plugin License

✨ Features

  • One-click focus & restart — Use Ctrl+Shift+G or Tools → Focus / Restart; hold Shift to rebuild the session
  • Auto-start — Automatically runs if copilot is detected on PATH or common install locations
  • Clean UI — Dedicated right-side ToolWindow; bottom terminal stays hidden
  • Smart Detection — Checks common paths (/opt/homebrew/bin, /usr/local/bin, etc.)
  • Smart Hints — Balloon notification with install instructions if CLI is not found

🚀 Installation

Prerequisites

  1. Install GitHub Copilot CLI:

    macOS/Linux:

    curl -fsSL https://gh.io/copilot-install | bash

    Windows:

    winget install GitHub.Copilot

    Or via npm:

    npm install -g @github/copilot
  2. Ensure copilot is available in your PATH

Plugin Installation

From Source

  1. Clone this repository
  2. Build with Gradle:
    ./gradlew buildPlugin
  3. Install the plugin from build/distributions/copilot-cli-jetbrains-*.zip

From JetBrains Marketplace

(Coming soon)

🛠 Usage

  1. Open any project in IntelliJ IDEA, WebStorm, PyCharm, etc.
  2. The Copilot CLI tool window appears on the right side
  3. Use Ctrl+Shift+G (Windows/Linux) or Cmd+Shift+G (macOS) to focus
  4. Hold Shift while pressing the shortcut to restart the session

📋 Requirements

  • IntelliJ IDEA 2023.2+ (or any JetBrains IDE based on IntelliJ Platform 232+)
  • Java 17+ (for building only)
  • GitHub Copilot CLI installed

🏗 Building

# Build the plugin
./gradlew buildPlugin

# Run in a sandbox IDE for testing
./gradlew runIde

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License - see LICENSE file for details.


Disclaimer: This plugin is an independent project and is not officially affiliated with or endorsed by GitHub.

About

JetBrains plugin to run GitHub Copilot CLI (copilot) in an embedded terminal

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages