Skip to content

gclm/gclm-code

Repository files navigation

Gclm Code

Gclm Code 是面向团队交付的命令行 AI 编码助手。

项目定位

  • 品牌与发行:统一为 Gclm / Gclm Code,npm 包名为 gclm-code
  • 接入策略:客户端走 ANTHROPIC_BASE_URL / ANTHROPIC_API_KEY,协议转换下沉网关
  • 模型发现:优先从网关 /models 动态获取,并支持缓存与错误语义提示
  • 验收门禁:以 verify + smoke 为发布前标准回归链路

安装与升级

npm 全局安装版(推荐,当前仅支持 macOS)

npm i -g gclm-code

说明:

  • 当前 npm 对外交付已切到 single-package + vendor runtime
  • 安装阶段会通过 postinstall 把当前平台 runtime 落到包内 vendor/runtime/<platform>/
  • 默认 runtime 来源为对应 tag 的 GitHub Release 资产,可通过 GCLM_BINARY_BASE_URL 覆盖
  • 首批仅支持 darwin-x64darwin-arm64
  • Linux / Windows 暂未纳入当前 npm 发布范围

首次安装后可用命令:

gc

升级 npm 全局安装版:

npm i -g gclm-code@latest
gc --version

仓库本地构建版(开发)

首次安装 / 本地构建:

git clone https://github.com/gclm/gclm-code.git
cd gclm-code
bun install
bun run build
./dist/gc

升级仓库本地构建版:

git pull
bun install
bun run build
./dist/gc --version

快速使用

# 交互模式
gc

# 一次性执行
gc -p "帮我分析当前目录结构"

# 指定模型
gc --model claude-sonnet-4-6

# 登录配置入口
gc /login

网关配置约定

/login 平台配置流程里输入:

  • ANTHROPIC_BASE_URL
  • ANTHROPIC_API_KEY

模型发现端点映射规则:

  • http://host -> http://host/v1/models
  • http://host/vN -> http://host/vN/models

验收与回归

# 构建与品牌守卫
bun run verify

# 分层包回归(core/gui/gateway)
bun run smoke:packages

# 单包本地回归(staging + tarball install + vendor runtime)
bun run smoke:single-package

# 如需把临时 registry 链路也一起带上
bun run smoke:single-package -- --with-registry

# 登录网关路径回归矩阵
SMOKE_GATEWAY_BASE_URL="http://localhost:8086/v1" \
SMOKE_GATEWAY_API_KEY="<your-key>" \
bun run smoke:login-gateway:matrix

发布说明

当前仓库根 package.json 仅用于开发工作区,不作为对外直发入口。

本项目当前以手动发布为主,PR 不是发布前置条件。

文档索引

  • 总索引:docs/README.md
  • 安装与升级:docs/overview/install-and-upgrade.md
  • 阶段路线:docs/overview/roadmap.md
  • 网关验收:docs/release/gateway-smoke-and-login.md

说明

install.sh 仍保留为源码安装路径的辅助脚本。 面向终端用户的默认安装方式仍建议使用 npm 全局安装。

致谢

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages