dgxay-code-cli 0.0.0-stage → 1.0.0

package/README-zh.md

@@ -0,0 +1,200 @@
+# DgxayCode CLI
+
+DgxayCode 的命令行版本：一个支持多协议、四档权限、自动审查、技能与 MCP 的 AI 编码助手。
+
+桌面版（Electron）的全部能力都搬到了终端里，只去掉了界面：
+
+- **三种接口协议**：OpenAI ChatCompletions、Anthropic Messages、OpenAI Responses，可自由切换供应商与模型
+- **工作模式**：读写文件、执行命令、访问网络，先读后写、完成前不停止
+- **四档权限**：无权限 / 普通权限 / 自动审查 / 完全权限，在进程内强制执行
+- **自动审查**：由审查模型判断每次操作，可疑操作转交你确认
+- **会话**：历史持久化、恢复、列表、重命名、删除、导出（最多保留 200 段）
+- **上下文压缩**：`/compress` 用摘要替换历史
+- **技能**：扫描 `~/.dcb/skills`，按会话启用
+- **MCP**：配置、启停、日志
+- **OAuth**：OpenAI / Anthropic / xAI / Google 账户连接（PKCE + 系统浏览器）
+- **自检**：`dgxay doctor` 检查环境与模型连通性
+
+## 安装
+
+需要 **Node.js 18 或更高版本**。
+
+```bash
+npm install -g dgxay-code-cli
+dgxay
+```
+
+也可以不安装直接用：
+
+```bash
+npx dgxay-code-cli --help
+```
+
+从源码安装：
+
+```bash
+git clone https://github.com/dgxay/DgxayCode.git
+cd DgxayCode-cli
+npm link          # 或 npm install -g .
+dgxay --version
+```
+
+## 快速开始
+
+```bash
+# 1. 首次配置：选择协议、填写 Base URL / API Key / 模型
+dgxay config init
+
+# 2. 自检
+dgxay doctor
+
+# 3. 进入交互模式
+dgxay
+```
+
+一条命令直接提问：
+
+```bash
+dgxay "把这个目录里的 JSON 合并成一个数组"
+
+# 指定工作空间、工作模式、自动审查
+dgxay run -p "给所有 Python 文件补上类型注解" -C ./project -m work --permission auto
+
+# 结构化输出，方便接管道
+dgxay run -p "总结这个仓库的架构" -o json | jq -r .text
+```
+
+## 交互模式
+
+进��� `dgxay` 后：
+
+| 输入 | 作用 |
+| --- | --- |
+| 直接输入文字 | 发送给模型 |
+| `!命令` | 执行终端命令，输出进入对话上下文，例如 `!git status` |
+| `/` | 打开斜杠命令补全 |
+| 行尾 `\` | 续行，输入多行消息 |
+| `Ctrl+C` | 生成中中断；空闲时退出；输入框有内容时清空 |
+| `Ctrl+D` | 退出 |
+| `↑` / `↓` | 浏览历史输入 |
+
+### 斜杠命令
+
+| 命令 | 说明 |
+| --- | --- |
+| `/help` | 查看全部命令 |
+| `/new` `/list` `/resume <序号>` `/delete <序号>` `/rename <标题>` | 会话管理 |
+| `/compress`（`/压缩`） | 压缩上下文，有损且不可撤销 |
+| `/skill [名称]`（`/技能`） | 列出 / 启用技能 |
+| `/model` `/provider` | 查看或切换模型 / 供应商 |
+| `/mode [chat\|work]` | 切换模式 |
+| `/permission [档位]` | 切换权限 |
+| `/cd <目录>` `/ls` `/pwd` | 工作空间 |
+| `/term <命令>` | 执行终端命令 |
+| `/context` | 上下文用量 |
+| `/mcp [子命令]` | MCP 管理 |
+| `/clear` `/exit` | 清屏 / 退出 |
+
+## 子命令
+
+```
+dgxay                       进入交互模式
+dgxay "问题"                 单次执行后退出
+dgxay run                   单次执行（-p / -C / -m / --permission / -o json）
+dgxay chat                  会话：list / show / resume / rm / rename / clear
+dgxay config                init / show / get / set / path / reset
+dgxay provider             list / add / edit / rm / use / mv / review
+dgxay model                list / use / add / rm / fetch
+dgxay oauth                list / connect / disconnect / client
+dgxay mcp                  list / add / start / stop / logs / rm / env
+dgxay skill                list / show / path
+dgxay workspace            set / list / clear
+dgxay permission           list / set
+dgxay context              查看上下文估算
+dgxay export               导出会话（Markdown / JSON）
+dgxay doctor               自检
+```
+
+任何子命令都可以加 `--help` 查看详细用法。
+
+## 权限
+
+| 档位 | 能力 | 授权 |
+| --- | --- | --- |
+| `none` 无权限 | 只能以只读方式访问工作空间内的文件 | 无 |
+| `normal` 普通权限 | 全部能力 | **每次**操作都要你确认 |
+| `auto` 自动审查 | 全部能力 | 先由审查模型判断，可疑才询问 |
+| `full` 完全权限 | 全部能力 | 不审查、不询问 |
+
+- 权限在工具执行层强制校验，改前端（这里是交互层）绕不过去。
+- 自动审查需要给供应商配置审查模型：`dgxay provider review <供应商> --model <模型ID>`；没配置时 `auto` 不可用，会自动回落到 `normal`。
+- 非交互环境（管道输入）遇到需要确认的操作一律拒绝；确实要放行时加 `--yes`。
+- 删除是**永久删除**，不进回收站；批量修改前请先提交 Git。
+
+## 数据与配置
+
+数据目录：`~/.dcb`（Windows 为 `%USERPROFILE%\.dcb`），与桌面版共用同一份配置与对话。
+
+```
+~/.dcb/
+├── config.json     # 供应商、模型、审查模型、模式、权限
+├── chats.json      # 对话历史（最多 200 段）
+├── oauth.json      # OAuth 客户端与账户令牌（0600）
+├── mcp.json        # MCP server 配置
+└── skills/         # 技能（SKILL.md 或 name.md）
+```
+
+- API Key 在 `config.json` 中**是明文**；不要把该目录发到公开仓库。
+- 用 `DGXAY_HOME=/tmp/test dgxay` 可以隔离数据目录（桌面版的 `DCB_HOME` 同样兼容）。
+- 如果本机从桌面版迁移，OAuth 令牌由 Electron `safeStorage` 加密，CLI 无法解密，需要重新执行 `dgxay oauth connect <平台>`。
+
+## 环境变量
+
+| 变量 | 作用 |
+| --- | --- |
+| `DGXAY_HOME` | 覆盖数据目录 |
+| `DGXAY_API_KEY` | `config init` 时用作 API Key |
+| `DGXAY_TOKEN_KEY` | 给 OAuth 令牌加解密口令（不设置则按明文 base64 保存） |
+| `DGXAY_SHOW_REASONING=1` | 实时显示思考过程（默认折叠为一行摘要） |
+| `DGXAY_COLOR=always\|never` | 强制开关颜色 |
+| `NO_COLOR` | 关闭颜色 |
+| `DGXAY_DEBUG=1` | 输出调试信息与堆栈 |
+| `DGXAY_OAUTH_NO_BROWSER=1` | 授权时不自动打开浏览器（只打印链接） |
+
+## 终端兼容性
+
+流式输出只使用 `\r`（回到行首）和空格覆盖两种所有终端都支持的能力，**不依赖光标上移或清行序列**——
+这两类序列在部分 Windows 控制台组合下会被忽略，导致每段增量都变成新的一行。
+
+渲染分两步：生成过程中只在最后一行实时刷新预览；生成结束时一次性地按 Markdown 完整排版输出
+（标题、列表、表格、代码块对齐）。所以在任何终端里每段正文都只会出现一次，不会堆积。
+
+## 与桌面版的差异
+
+- 没有窗口、没有快捷键，全部操作用命令或斜杠命令完成。
+- 上下文圆环换成输入框上方的状态行和 `/context`。
+- OAuth 令牌不再使用系统钥匙串加密；可用 `DGXAY_TOKEN_KEY` 开启加密。
+- 补上了桌面版没有的能力：`dgxay run` 单次执行、`export` 导出、`doctor` 自检。
+
+## 已知限制
+
+- 每次请求只发送最近 **24 条**消息，更早的内容会被丢弃；长对话请先 `/compress` 或另起会话。
+- `/compress` 有损且不可撤销。
+- MCP 目前只管理进程，**尚未把 MCP 工具暴露给模型**（与桌面版一致）。
+- 终端命令没有 PTY，不支持 `vim` / `top` / `ssh` 等交互式命令。
+- 自动审查是 LLM，可能判断错误，不能代替人工审查。
+- 上下文用量是字符启发式估算，实际 token 以模型返回的 `usage` 为准。
+
+## 开发
+
+```bash
+npm test            # 运行全部测试（内置 mock 服务，不消耗真实额度）
+npm run pack:check  # 检查 npm 发布内容
+node bin/dgxay.js --help
+```
+
+测试覆盖：三种协议的流式与工具调用、权限矩阵（含拒绝路径）、会话持久化与压缩、SSE 分块解析、Markdown 渲染、参数解析。
+
+## 许可证
+
+GNU General Public License v3.0，见 [LICENSE](./LICENSE)。

package/README.md

@@ -1,3 +1,183 @@
-# Temporary Holding Version
+# DgxayCode CLI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The command-line edition of DgxayCode: a multi-protocol AI coding agent with four permission levels, model-based safety review, skills and MCP support.
+
+Everything the desktop (Electron) app can do is available here — only the UI is gone:
+
+- **Three protocols** — OpenAI ChatCompletions, Anthropic Messages and OpenAI Responses; switch providers and models freely.
+- **Work mode** — read/write files, run commands, fetch URLs; works through a task to completion instead of stopping at a plan.
+- **Four permission levels** — none / normal / auto-review / full, enforced inside the tool layer.
+- **Auto review** — a reviewer model judges each operation; suspicious ones are handed back to you.
+- **Sessions** — persisted history, resume, list, rename, delete, export (200 sessions max).
+- **Context compression** — `/compress` replaces history with a summary.
+- **Skills** — scanned from `~/.dcb/skills`, enabled per conversation.
+- **MCP** — configure, start, stop, inspect logs.
+- **OAuth** — connect OpenAI / Anthropic / xAI / Google accounts (PKCE, system browser).
+- **Self-check** — `dgxay doctor` verifies environment and model connectivity.
+
+## Install
+
+Requires **Node.js 18+**.
+
+```bash
+npm install -g dgxay-code-cli
+dgxay
+```
+
+Or run without installing:
+
+```bash
+npx dgxay-code-cli --help
+```
+
+From source:
+
+```bash
+git clone https://github.com/dgxay/DgxayCode.git
+cd DgxayCode-cli
+npm link          # or: npm install -g .
+dgxay --version
+```
+
+## Quick start
+
+```bash
+# 1. First-time setup: protocol, Base URL, API key, model
+dgxay config init
+
+# 2. Self-check
+dgxay doctor
+
+# 3. Interactive mode
+dgxay
+```
+
+Ask once and exit:
+
+```bash
+dgxay "merge every JSON file in this folder into one array"
+
+# work mode with auto review
+dgxay run -p "add type hints to all Python files" -C ./project -m work --permission auto
+
+# structured output
+dgxay run -p "summarize this repo's architecture" -o json | jq -r .text
+```
+
+## Interactive mode
+
+| Input | Action |
+| --- | --- |
+| text | Send to the model |
+| `!command` | Run a shell command; output joins the context, e.g. `!git status` |
+| `/` | Slash-command completion |
+| trailing `\` | Continue on the next line |
+| `Ctrl+C` | Abort while generating; clear the input when non-empty; exit when idle |
+| `Ctrl+D` | Exit |
+| `↑` / `↓` | Input history |
+
+### Slash commands
+
+`/help` `/new` `/list` `/resume` `/delete` `/rename` `/compress` `/skill` `/model` `/provider` `/mode` `/permission` `/cd` `/ls` `/pwd` `/term` `/context` `/mcp` `/clear` `/exit`
+
+## Subcommands
+
+```
+dgxay                       interactive mode
+dgxay "question"            one-shot ask
+dgxay run                   one-shot ask (-p / -C / -m / --permission / -o json)
+dgxay chat                  list / show / resume / rm / rename / clear
+dgxay config                init / show / get / set / path / reset
+dgxay provider              list / add / edit / rm / use / mv / review
+dgxay model                 list / use / add / rm / fetch
+dgxay oauth                 list / connect / disconnect / client
+dgxay mcp                   list / add / start / stop / logs / rm / env
+dgxay skill                 list / show / path
+dgxay workspace             set / list / clear
+dgxay permission            list / set
+dgxay context               context usage estimate
+dgxay export                export a session (Markdown / JSON)
+dgxay doctor                self-check
+```
+
+Every subcommand supports `--help`.
+
+## Permissions
+
+| Level | Capabilities | Approval |
+| --- | --- | --- |
+| `none` | read-only inside the workspace | none |
+| `normal` | everything | **every** operation needs your confirmation |
+| `auto` | everything | reviewer model decides; suspicious operations ask you |
+| `full` | everything | no review, no prompts |
+
+- Enforced in the tool layer — the UI (here, the REPL) cannot bypass it.
+- Auto review requires a review model: `dgxay provider review <provider> --model <modelId>`; without it `auto` is unavailable and falls back to `normal`.
+- In non-interactive pipelines, approval-requiring operations are denied unless you pass `--yes`.
+- Deletions are **permanent** (no trash). Commit to Git before bulk edits.
+
+## Data
+
+`~/.dcb` (Windows: `%USERPROFILE%\.dcb`), shared with the desktop app:
+
+```
+~/.dcb/
+├── config.json     # providers, models, review models, mode, permission
+├── chats.json      # conversation history (200 sessions max)
+├── oauth.json      # OAuth client + tokens (0600)
+├── mcp.json        # MCP servers
+└── skills/         # SKILL.md or name.md
+```
+
+API keys are stored **in plain text** in `config.json`. Use `DGXAY_HOME=/tmp/test dgxay` to isolate a data directory (desktop's `DCB_HOME` also works). OAuth tokens written by the desktop app are encrypted with Electron `safeStorage` and cannot be read by the CLI — reconnect with `dgxay oauth connect <platform>`.
+
+## Environment variables
+
+| Variable | Purpose |
+| --- | --- |
+| `DGXAY_HOME` | Override the data directory |
+| `DGXAY_API_KEY` | API key used by `config init` |
+| `DGXAY_TOKEN_KEY` | Passphrase that encrypts OAuth tokens (plain base64 otherwise) |
+| `DGXAY_SHOW_REASONING=1` | Stream the reasoning text (collapsed to one line by default) |
+| `DGXAY_COLOR=always\|never` | Force colours on/off |
+| `NO_COLOR` | Disable colours |
+| `DGXAY_DEBUG=1` | Debug output and stack traces |
+| `DGXAY_OAUTH_NO_BROWSER=1` | Don't open a browser during OAuth; print the URL only |
+
+## Terminal compatibility
+
+Streaming output relies only on `\r` (carriage return) and space padding — capabilities every terminal supports.
+It never uses cursor-up or erase-line sequences: some Windows console combinations silently ignore them, which
+makes every delta arrive as a new line.
+
+Rendering happens in two steps: while generating, only the current line is refreshed as a plain-text preview;
+when generation ends, the whole reply is laid out once as Markdown (headings, lists, tables, code blocks).
+Every paragraph therefore appears exactly once in any terminal.
+
+## Differences from the desktop app
+
+- No window and no global shortcuts — everything is a subcommand or slash command.
+- The context ring becomes a status line plus `/context`.
+- OAuth tokens no longer use the OS keychain; set `DGXAY_TOKEN_KEY` to encrypt them.
+- New in the CLI: `dgxay run`, `export`, `doctor`.
+
+## Known limitations
+
+- Only the most recent **24** messages are sent per request; compress or start a new session for long conversations.
+- `/compress` is lossy and cannot be undone.
+- MCP is process management only — MCP tools are **not** exposed to the model yet (same as desktop).
+- Shell commands have no PTY: no `vim`, `top` or `ssh`.
+- Auto review is an LLM and can be wrong; it is not a sandbox.
+- Context usage is a character-based estimate; rely on the model's `usage` for real tokens.
+
+## Development
+
+```bash
+npm test            # full suite against a built-in mock server (no real API usage)
+npm run pack:check  # inspect the npm tarball
+node bin/dgxay.js --help
+```
+
+## License
+
+GNU General Public License v3.0 — see [LICENSE](./LICENSE). 中文说明见 [README-zh.md](./README-zh.md).

package/bin/dgxay.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * DgxayCode CLI 可执行入口。
+ *
+ * 全局安装后直接运行 `dgxay` 即可：
+ *   npm install -g dgxay-code-cli
+ *   dgxay
+ *
+ * 这里只做三件事：检查 Node 版本、屏蔽不兼容的交互环境、把控制权交给 src/cli/index.js。
+ * 真正的参数解析与业务逻辑都在 cli 层，保证入口文件足够小、在任何平台都能被 npm 正常解析。
+ */
+
+const MIN_MAJOR = 18;
+
+const major = Number(process.versions.node.split('.')[0]);
+if (!Number.isFinite(major) || major < MIN_MAJOR) {
+  process.stderr.write(
+    `DgxayCode CLI 需要 Node.js ${MIN_MAJOR} 或更高版本，当前为 ${process.versions.node}。\n` +
+      '请升级 Node.js 后重试：https://nodejs.org/\n'
+  );
+  process.exit(1);
+}
+
+function run() {
+  require('../src/cli/index.js')
+    .main(process.argv.slice(2))
+    .then((code) => {
+      if (typeof code === 'number' && code !== 0) process.exitCode = code;
+    })
+    .catch((error) => {
+      const message = error && error.message ? error.message : String(error);
+      process.stderr.write(`\n发生未处理的错误：${message}\n`);
+      if (process.env.DGXAY_DEBUG === '1' && error && error.stack) {
+        process.stderr.write(`${error.stack}\n`);
+      }
+      process.exitCode = 1;
+    });
+}
+
+run();

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "dgxay-code-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "productName": "DgxayCode CLI",
+  "version": "1.0.0",
+  "description": "DgxayCode 命令行版：多协议 AI 编码助手，支持工作空间、四档权限、自动审查、技能与 MCP。",
+  "author": "Dgxay",
+  "license": "GPL-3.0-only",
+  "bin": {
+    "dgxay": "bin/dgxay.js"
+  },
+  "main": "src/cli/index.js",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "bin/**/*",
+    "src/**/*",
+    "README.md",
+    "README-zh.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "cli",
+    "ai",
+    "agent",
+    "coding-assistant",
+    "ai-coding",
+    "openai",
+    "anthropic",
+    "deepseek",
+    "llm",
+    "mcp",
+    "terminal"
+  ],
+  "scripts": {
+    "start": "node bin/dgxay.js",
+    "test": "node test/run.js",
+    "pack:check": "npm pack --dry-run"
+  },
+  "homepage": "https://github.com/dgxay/DgxayCode",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dgxay/DgxayCode.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dgxay/DgxayCode/issues"
+  }
+}