cbc-it-here 1.0.0 → 1.0.1

package/.cbc-it.json

@@ -0,0 +1,5 @@
+{
+  "options": {
+    "permissionMode": "bypassPermissions"
+  }
+}

package/.codebuddy/plans/fulfill-readme_a2f49f27.md

@@ -0,0 +1,68 @@
+---
+name: fulfill-readme
+overview: 完善 README.md，补充项目简介、功能特性、安装说明、使用方法、环境要求、License 等信息，并同步更新 README.en.md。
+todos:
+  - id: rewrite-readme-zh
+    content: 重写 README.md 中文文档，补充完整的项目介绍、功能特性、安装、使用、配置、输出示例、贡献指南等内容
+    status: completed
+  - id: rewrite-readme-en
+    content: 重写 README.en.md 英文文档，与中文 README 结构和内容保持同步对齐
+    status: completed
+    dependencies:
+      - rewrite-readme-zh
+---
+
+## 用户需求
+
+完善项目根目录的 `README.md`，使其内容完整、专业、可用。当前 README.md 内容过于简陋，缺少功能特性、环境要求、前置条件、task.md 格式说明、输出示例、配置项等关键信息。同时 `README.en.md` 仍为 Gitee 模板默认内容，也需要同步完善。
+
+## 项目背景
+
+- **项目名**: cbc-it-here
+- **类型**: 全局 Node.js CLI 工具
+- **功能**: 在任意项目目录下运行 `cbc-it` 命令，读取当前目录的 `task.md` 文件，通过 `@tencent-ai/agent-sdk` 调用 CodeBuddy AI 代理执行任务
+- **入口**: index.js（ES Module），调用 `query()` 发送 prompt，使用 `permissionMode: 'bypassPermissions'`，流式输出 AI 回复文本和执行结果（耗时/费用）
+- **依赖**: `@tencent-ai/agent-sdk ^0.3.92`
+- **仓库**: https://gitee.com/z168w/cbc-it-here.git
+- **License**: CC BY 4.0
+- **作者**: z1680w
+
+## 核心特性
+
+- 读取当前目录 `task.md` 作为任务描述，自动提交给 CodeBuddy AI 执行
+- 流式实时输出 AI 回复内容
+- 执行完成后显示耗时（ms）和费用（USD）
+- 以 bypassPermissions 模式运行，自动授权 AI 代理操作
+
+## 技术方案
+
+纯文档修改任务，不涉及代码实现。
+
+### 修改文件
+
+- `README.md` - 重写中文 README，补充完整内容
+- `README.en.md` - 重写英文 README，与中文版本同步
+
+### README 内容结构（基于实际代码逻辑）
+
+1. **项目标题 + 徽章** - 名称、版本、License
+2. **项目简介** - 一句话描述核心功能
+3. **功能特性** - 流式输出、自动执行、耗时统计等
+4. **前置条件** - Node.js >= 18（ES Module + async iterator）、CodeBuddy API Key 环境变量
+5. **安装** - pnpm add -g z1680/cbc-it-here
+6. **使用说明** - 创建 task.md → 运行 cbc-it → 查看输出
+7. **task.md 格式** - Markdown checkbox 列表格式说明，引用 task.md 实际内容作为示例
+8. **输出示例** - 展示 AI 回复文本 + 完成耗时/费用格式的终端输出效果
+9. **工作原理** - 简述 index.js 的执行流程（读取 task.md → query() → 流式输出）
+10. **配置** - permissionMode: bypassPermissions 说明
+11. **常见问题** - API Key 配置、网络问题等
+12. **贡献指南** - Fork → PR 流程
+13. **许可证** - CC BY 4.0
+
+### 关键约束
+
+- 基于实际 `index.js` 代码逻辑描述功能，不虚构不存在的特性
+- task.md 示例使用项目中的真实内容
+- 输出示例与代码中的 console.log 格式一致（"完成！耗时：xxx ms"、"费用：xxx USD"）
+- 不添加 package.json 中不存在的 bin 字段到文档中（当前 CLI 注册方式通过安装包处理）
+- 中英文 README 内容保持结构一致、语义对齐

package/README.en.md

@@ -1,36 +1,91 @@
 # cbc-it-here
 
-#### Description
-cbc-it-here
+A global Node.js CLI tool that reads a `task.md` file in any project directory and automatically executes tasks via the [CodeBuddy Agent SDK](https://github.com/Tencent-ai/agent-sdk).
 
-#### Software Architecture
-Software architecture description
+## Features
 
-#### Installation
+- Reads `task.md` in the current directory and submits tasks to the CodeBuddy AI agent
+- Streams AI responses in real time
+- Displays execution time and cost upon completion
+- Runs in auto-approve mode — no manual confirmation needed
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+## Prerequisites
 
-#### Instructions
+- [Node.js](https://nodejs.org/) >= 18 (ES Module and async iterator support required)
+- CodeBuddy API Key configured as an environment variable
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+## Installation
 
-#### Contribution
+```bash
+pnpm add -g z1680/cbc-it-here
+```
 
-1.  Fork the repository
-2.  Create Feat_xxx branch
-3.  Commit your code
-4.  Create Pull Request
+## Usage
 
+### 1. Create a `task.md` file in your project root
 
-#### Gitee Feature
+Write your tasks using Markdown checkbox lists:
 
-1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
-2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
-3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
-4.  The most valuable open source project [GVP](https://gitee.com/gvp)
-5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
-6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+```markdown
+- [ ] Write the current time to time4.txt in the current directory
+- [ ] Write the current time to time5.txt in the current directory
+- [ ] Write the current time to time6.txt in the current directory
+```
+
+### 2. (Optional) Create a configuration file
+
+Create a configuration file in your project root to customize behavior. The following filenames are supported (in priority order):
+
+- `.cbc-it.json`
+- `.cbc-it.js`
+- `cbc-it.config.js`
+- `cbc-it.config.json`
+
+**JSON config example (`.cbc-it.json`)**:
+
+```json
+{
+  "options": {
+    "permissionMode": "bypassPermissions"
+  }
+}
+```
+
+**JS config example (`.cbc-it.js`)**:
+
+```js
+export default {
+  options: {
+    permissionMode: 'bypassPermissions'
+  }
+}
+```
+
+If no configuration file is created, the default configuration will be used (`permissionMode: 'bypassPermissions'`).
+
+### 3. Run the command
+
+```bash
+cbc-it
+```
+
+### 4. View the output
+
+The tool streams the AI agent's responses in real time. Upon completion, it displays:
+
+```
+Done! Time: xxxx ms
+Cost: x.xxxx USD
+```
+
+## How It Works
+
+1. Reads the `task.md` file in the current directory
+2. Calls the CodeBuddy Agent SDK `query()` method to submit the task to the AI agent
+3. Runs in `bypassPermissions` mode, granting the AI agent full permissions automatically
+4. Streams and outputs the AI agent's responses in real time
+5. Displays execution time (milliseconds) and cost (USD) after the task completes
+
+## License
+
+[CC BY 4.0](LICENSE)

package/README.md

@@ -1,20 +1,91 @@
 # cbc-it-here
 
-#### 介绍
+全局 Node.js CLI 工具，在任意项目目录下读取 `task.md` 文件，通过 [CodeBuddy Agent SDK](https://github.com/Tencent-ai/agent-sdk) 自动执行任务。
 
-cbc it here when installed will do tasks in task.md with cbc 
+## 功能特性
 
-#### 软件架构
+- 读取当前目录 `task.md` 作为任务描述，自动提交给 CodeBuddy AI 代理执行
+- 流式实时输出 AI 回复内容
+- 执行完成后显示耗时和费用
+- 以自动授权模式运行，无需手动确认
 
-node in type module
+## 前置条件
 
+- [Node.js](https://nodejs.org/) >= 18（需要 ES Module 和 async iterator 支持）
+- 已配置 CodeBuddy API Key 环境变量
 
-#### 安装教程
+## 安装
 
-pnpm add z1680/cbc-it-here
+```bash
+pnpm add -g z1680/cbc-it-here
+```
 
-#### 使用说明
+## 使用说明
 
-1. update task.md in project root
+### 1. 在项目根目录创建 `task.md`
 
-2. npx cbc-it
+使用 Markdown checkbox 列表格式编写任务：
+
+```markdown
+- [ ] 将现在时间写入当前目录time4.txt
+- [ ] 将现在时间写入当前目录time5.txt
+- [ ] 将现在时间写入当前目录time6.txt
+```
+
+### 2. （可选）创建配置文件
+
+在项目根目录创建配置文件来自定义行为。支持以下文件名（按优先级排序）：
+
+- `.cbc-it.json`
+- `.cbc-it.js`
+- `cbc-it.config.js`
+- `cbc-it.config.json`
+
+**JSON 配置示例 (`.cbc-it.json`)**:
+
+```json
+{
+  "options": {
+    "permissionMode": "bypassPermissions"
+  }
+}
+```
+
+**JS 配置示例 (`.cbc-it.js`)**:
+
+```js
+export default {
+  options: {
+    permissionMode: 'bypassPermissions'
+  }
+}
+```
+
+如未创建配置文件，将使用默认配置（`permissionMode: 'bypassPermissions'`）。
+
+### 3. 运行命令
+
+```bash
+cbc-it
+```
+
+### 4. 查看输出
+
+工具会流式输出 AI 代理的回复文本，任务完成后显示：
+
+```
+完成！耗时：xxxx ms
+费用：x.xxxx USD
+```
+
+## 工作原理
+
+1. 读取当前目录下的 `task.md` 文件内容
+2. 调用 CodeBuddy Agent SDK 的 `query()` 方法，将任务提交给 AI 代理
+3. 以 `bypassPermissions` 模式运行，AI 代理自动获得操作权限
+4. 流式接收并输出 AI 代理的回复内容
+5. 任务完成后输出耗时（毫秒）和费用（美元）
+
+## 许可证
+
+[CC BY 4.0](LICENSE)

package/index.js

@@ -1,12 +1,48 @@
 import { query } from '@tencent-ai/agent-sdk';
+import { readFileSync, existsSync } from 'fs';
+import { resolve } from 'path';
 
-async function main() {
-  const q = query({
-    prompt: '执行当前目录task.md',
-    options: {
-      permissionMode: 'bypassPermissions'
+async function loadConfig() {
+  const configPaths = [
+    resolve(process.cwd(), '.cbc-it.json'),
+    resolve(process.cwd(), '.cbc-it.js'),
+    resolve(process.cwd(), 'cbc-it.config.js'),
+    resolve(process.cwd(), 'cbc-it.config.json'),
+  ];
+
+  for (const configPath of configPaths) {
+    if (existsSync(configPath)) {
+      if (configPath.endsWith('.json')) {
+        const content = readFileSync(configPath, 'utf-8');
+        return JSON.parse(content);
+      } else if (configPath.endsWith('.js')) {
+        const configModule = await import(configPath);
+        return configModule.default || configModule;
+      }
     }
-  });
+  }
+
+  return {};
+}
+
+async function main() {
+  const taskPath = resolve(process.cwd(), 'task.md');
+  
+  if (!existsSync(taskPath)) {
+    console.error('错误：未找到 task.md 文件');
+    process.exit(1);
+  }
+
+  const prompt = readFileSync(taskPath, 'utf-8');
+  
+  const config = await loadConfig();
+
+  const queryOptions = {
+    prompt,
+    ...config.options
+  };
+
+  const q = query(queryOptions);
 
   for await (const message of q) {
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cbc-it-here",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "cbc it here",
   "keywords": [
     "tool"
@@ -13,6 +13,9 @@
   "author": "z1680w",
   "type": "module",
   "main": "index.js",
+  "bin": {
+    "cbc-it": "index.js"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },