dsh-open-auth-plugin

English | 简体中文

一个 DSH LLM 插件，同时接入 pi-ai 当前内置的所有聊天 Provider，并提供统一的 OAuth/API Key 登录 CLI。插件和 CLI 共用同一个受文件权限保护的令牌文件，因此 OpenAI Codex、Kimi Code、GitHub Copilot 等订阅登录可直接用于 DSH 的模型请求。

这不是 OpenAI API Key 到 ChatGPT 订阅的转换。openai-codex 使用 pi-ai 实现的 OpenAI Codex OAuth 和 ChatGPT backend；是否可用、支持哪些模型以及额度限制仍由 OpenAI 账户和适用的服务条款决定。

安装

要求 Node.js 22.19 或更高版本。

将包安装到 DSH profile 中（如果使用其他 profile，请将 web 替换成对应名称）：

dsh plugin --profile web add dsh-open-auth

如果你的 DSH 运行时是普通 Node.js 项目，则在该项目中安装：

npm install dsh-open-auth

然后按照下文说明将插件加入 DSH 配置。通过 dsh plugin add 安装时，内置的默认配置会自动生效。

身份认证

安装到 DSH profile 后，通过该 profile 执行 CLI。登录 OpenAI Codex 订阅：

dsh plugin --profile web exec dsh-open-auth login openai-codex
dsh plugin --profile web exec dsh-open-auth status openai-codex

登录 Kimi Code 订阅：

dsh plugin --profile web exec dsh-open-auth login kimi-coding oauth

查看 pi-ai 当前提供的全部 Provider 和模型：

dsh plugin --profile web exec dsh-open-auth providers
dsh plugin --profile web exec dsh-open-auth models openai-codex

如果通过普通 npm 项目本地安装，请把上述命令前缀替换为 npx，例如：npx dsh-open-auth login openai-codex。

DSH 配置

内置配置默认注册 pi-ai 的全部聊天 Provider。安装到 profile 后无需额外配置，可以先在不启动 DSH 的情况下检查组合结果：

dsh --profile web --dump-config

如需限制注册的路由，在该 profile 的 cordis.patch.yml 中加入以下覆盖配置：

- id: llm-open-auth
  config:
    providers:
      - openai-codex
      - kimi-coding
      - anthropic
      - openrouter
    streamIdleTimeoutMs: 300000

如果使用不基于 DSH profile 的独立 Cordis 配置，则将本包作为普通插件条目加入 cordis.yml：

- id: llm-open-auth
  name: dsh-open-auth
  config: {}

不要同时加载另一个占用相同 Provider 路由的 LLM 插件。例如，同时让本插件和官方 llm-pi-ai 注册 anthropic 时，DSH 会按设计拒绝重复路由。

凭据存储

默认位置：

• macOS: ~/Library/Application Support/dsh-open-auth/auth.json
• Linux: $XDG_CONFIG_HOME/dsh-open-auth/auth.json 或 ~/.config/dsh-open-auth/auth.json
• Windows: %APPDATA%/dsh-open-auth/auth.json

可以在 CLI 使用 --file PATH，在插件中设置 credentialFile，或统一设置 DSH_OPEN_AUTH_FILE。文件以 0600 权限创建，更新使用同目录原子替换；写入和 token 刷新通过跨进程锁串行化。该文件不是系统钥匙串，也没有额外加密；不要上传、共享或提交到 Git。

API Key Provider 也可继续使用 pi-ai 支持的标准环境变量，例如 OPENAI_API_KEY、ANTHROPIC_API_KEY、DEEPSEEK_API_KEY。执行 dsh-open-auth login PROVIDER api_key 则会将 key 存入共享凭据文件。AWS Bedrock、Google Vertex 等 ambient-only Provider 按 pi-ai 约定读取环境变量或本机凭据文件。

架构

flowchart LR
  CLI["dsh-open-auth CLI"] --> Store["共享 CredentialStore"]
  DSH["DSH dsh-open-auth 插件"] --> Store
  DSH --> Models["pi-ai builtinModels"]
  CLI --> Models
  Models --> OAuth["Provider OAuth / token 刷新"]
  Models --> APIs["OpenAI Codex、Kimi、Anthropic 等"]

本项目不会重复维护 Provider 白名单；builtinModels() 是唯一来源。因此升级 @earendil-works/pi-ai 后，新内置 Provider 会自动进入 CLI 和默认 DSH 路由。

开发

npm install
npm run check
npm test
npm run build

发布

npm 包名为 dsh-open-auth。包内包含 dsh.bundle 声明和 cordis.patch.yml，因此 dsh plugin add 会把它作为 profile 配置层安装并自动启用。发布前，prepublishOnly 会自动执行类型检查、测试和生产构建。

npm login
npm publish

可以先执行 npm pack --dry-run，在不上传文件的情况下检查最终发布内容。

本项目的 DSH 消息、流事件和 replay 映射基于 DeepSeek Harness 的 MIT 实现调整，详见 NOTICE。