JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2442
  • Score
    100M100P100Q142920F

A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (copilot-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Copilot API

    ⚠️ EDUCATIONAL PURPOSE ONLY ⚠️ This project is a reverse-engineered implementation of the GitHub Copilot API created for educational purposes only. It is not officially supported by GitHub and should not be used in production environments.

    Project Overview

    A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools.

    Note: Image/vision capabilities are not supported as GitHub Copilot's API does not support image input.

    Prerequisites

    • Bun (version 1.0.0 or higher)
    • GitHub account with Copilot Individual subscription

    Installation

    To install dependencies, run:

    bun install

    Using with npx

    You can run the project directly using npx:

    npx copilot-api

    With options:

    npx copilot-api --port 8080 --emulate-streaming

    Running from Source

    The project can be run from source in several ways:

    Development Mode

    bun run dev

    Starts the server with hot reloading enabled, which automatically restarts the server when code changes are detected. This is ideal for development.

    Production Mode

    bun run start

    Runs the server in production mode with optimizations enabled and hot reloading disabled. Use this for deployment or production environments.

    Command Line Options

    The server accepts several command line options:

    Option Description Default
    --help, -h Show help message false
    --emulate-streaming Enable streaming response emulation false
    --port, -p Port to listen on 4141
    --logs Write logs to the app directory (requires --emulate-streaming) false

    Example with options:

    bun run start --port 8080 --emulate-streaming

    In all cases, the server will start and listen for API requests on the specified port.

    Tested Tools Compatibility

    The following AI tools have been tested with this API:

    Cline

    • Works with GPT-4o
    • Not compatible with Claude 3.5 Sonnet (Cline prompts are too long)

    Aider

    • Fully compatible

    bolt.diy

    • Sometimes models fail to load - you can set any random API key in the UI to refresh the models list

    Contributing

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

    License

    This project is licensed under the GNU General Public License v3.0.