Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

copilot-local

以离线模式启动 GitHub Copilot CLI,使用第三方模型提供商(BYOK - Bring Your Own Key)。不干扰原本的copilot cli环境。

功能特性

  • 🔌 支持任意 OpenAI 兼容 API 端点
  • 🔑 通过配置文件管理 API Key,避免硬编码
  • 🚀 自动检测 Node.js 和 Copilot CLI 路径
  • 🎯 支持命令行参数覆盖配置
  • 📋 内置配置查看和帮助信息

前置要求

  1. Node.js — 已安装并在 PATH 中
  2. GitHub Copilot CLI — 通过 npm 全局安装:
    npm install -g @github/copilot
  3. 有效的 API Key — 来自你的模型提供商

快速开始

1. 创建配置文件

将示例配置复制为 config.env

# Windows
copy config.env.example config.env

# Linux / macOS
cp config.env.example config.env

2. 编辑配置

打开 config.env,填入你的 API 信息:

COPILOT_PROVIDER_BASE_URL=https://your-api-endpoint.com/v1
COPILOT_PROVIDER_TYPE=openai
COPILOT_PROVIDER_API_KEY=your-api-key-here
COPILOT_MODEL=your-model-name

3. 添加到 PATH(可选,推荐)

将项目目录添加到系统 PATH 环境变量,即可在任意目录下直接运行 copilot-local

Windows(PowerShell 管理员):

# 当前用户永久生效
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\work\github\copilot-cli-local", "User")

或通过 GUI 操作:系统属性高级环境变量 → 编辑用户 Path → 新建 → 填入项目目录路径。

Linux / macOS:

# 添加到 ~/.bashrc 或 ~/.zshrc
echo 'export PATH="$PATH:/path/to/copilot-cli-local"' >> ~/.bashrc
source ~/.bashrc

添加后重新打开终端即可生效。

4. 运行

# Windows
copilot-local

# Linux / macOS(首次需要赋予执行权限)
chmod +x copilot-local.sh
copilot-local.sh

配置说明

配置项 说明 默认值
COPILOT_PROVIDER_BASE_URL API 端点地址 https://token-plan-cn.xiaomimimo.com/v1
COPILOT_PROVIDER_TYPE 提供商类型 openai
COPILOT_PROVIDER_API_KEY API 密钥 your-api-key-here
COPILOT_MODEL 默认模型名称 mimo-v2.5-pro
COPILOT_PROVIDER_MAX_PROMPT_TOKENS 最大 Prompt Token 数 900000
COPILOT_PROVIDER_MAX_OUTPUT_TOKENS 最大输出 Token 数 131072
NODE_EXE Node.js 可执行文件路径 自动检测
COPILOT_ENTRY Copilot 入口脚本路径 自动检测

命令行用法

# Windows                    # Linux / macOS
copilot-local                ./copilot-local.sh

# 指定模型(覆盖配置文件)
copilot-local --model qwen/qwen3-coder-next
copilot-local -m deepseek/deepseek-coder

# 查看当前配置
copilot-local --config

# 显示帮助
copilot-local --help

# 传递额外参数给 Copilot CLI
copilot-local --version

配置优先级

配置按以下优先级生效(高 → 低):

  1. 命令行参数--model / -m
  2. 配置文件config.env
  3. 默认值 — 脚本内置

文件结构

copilot-cli-local/
├── copilot-local.bat       # Windows 启动脚本
├── copilot-local.sh        # Linux / macOS 启动脚本
├── config.env              # 你的配置文件(需自行创建)
├── config.env.example      # 配置模板
└── README.md               # 本文档

常见问题

Node.js 未找到

确保 Node.js 已安装并在 PATH 中,或在 config.env 中指定路径:

# Windows
NODE_EXE=C:\Program Files\nodejs\node.exe

# Linux / macOS
NODE_EXE=/usr/local/bin/node

Copilot CLI 未找到

安装 GitHub Copilot CLI:

npm install -g @github/copilot

或在 config.env 中指定入口路径:

# Windows
COPILOT_ENTRY=C:\Users\YourName\AppData\Roaming\npm\node_modules\@github\copilot\npm-loader.js

# Linux / macOS
COPILOT_ENTRY=/usr/local/lib/node_modules/@github/copilot/npm-loader.js

Linux / macOS 权限问题

首次运行需要赋予执行权限:

chmod +x copilot-local.sh

config.env 中的注释和空行

  • # 开头的行会被忽略
  • 空行会被跳过
  • 值中不要包含 =

许可证

MIT

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages