tools-cc 1.0.1 → 1.0.3

package/AGENTS.md

@@ -0,0 +1,164 @@
+# tools-cc 项目上下文
+
+## 项目概述
+
+tools-cc 是一个 CLI 工具，用于统一管理多个 AI 编程工具（iflow、claude、codebuddy、opencode 等）的 skills/commands/agents 配置。通过符号链接机制，避免在多个工具间重复配置。
+
+## 技术栈
+
+- **语言**: TypeScript (ES2020, strict mode)
+- **CLI 框架**: Commander.js
+- **文件操作**: fs-extra
+- **终端输出**: chalk
+- **交互式命令**: inquirer
+- **测试框架**: vitest
+- **运行时**: Node.js (CommonJS)
+
+## 项目结构
+
+```
+tools-cc/
+├── src/
+│   ├── index.ts          # CLI 入口，命令注册
+│   ├── commands/         # CLI 命令处理器
+│   │   ├── config.ts     # 配置管理命令
+│   │   ├── help.ts       # 帮助信息
+│   │   ├── source.ts     # 源管理命令
+│   │   └── use.ts        # 项目使用命令
+│   ├── core/             # 核心业务逻辑
+│   │   ├── config.ts     # 配置读写
+│   │   ├── manifest.ts   # manifest.json 解析
+│   │   ├── project.ts    # 项目管理
+│   │   ├── source.ts     # 源管理
+│   │   └── symlink.ts    # 符号链接创建
+│   ├── types/            # TypeScript 类型定义
+│   │   └── config.ts     # 核心接口定义
+│   └── utils/
+│       └── path.ts       # 路径常量和工具函数
+├── tests/                # 测试文件
+│   ├── core/             # 核心模块测试
+│   └── fixtures/         # 测试固件
+└── dist/                 # 编译输出
+```
+
+## 构建和运行
+
+```bash
+# 安装依赖
+npm install
+
+# 开发模式运行
+npm run dev
+
+# 编译 TypeScript
+npm run build
+
+# 运行编译后的代码
+npm start
+
+# 运行测试
+npm test
+
+# 运行测试（单次）
+npm run test:run
+
+# 全局安装（开发）
+npm link
+```
+
+## 核心命令
+
+### 全局配置源管理
+- `tools-cc -s add <name> <path-or-url>` - 添加配置源
+- `tools-cc -s list` - 列出所有配置源
+- `tools-cc -s remove <name>` - 移除配置源
+- `tools-cc -s update [name]` - git pull 更新源代码
+- `tools-cc -s scan` - 扫描目录发现新源
+
+### 项目配置
+- `tools-cc use [sources...] [-p tools...]` - 启用配置源并创建符号链接
+- `tools-cc update [sources...]` - 同步源内容到项目
+- `tools-cc list` - 列出已启用的配置源
+- `tools-cc rm <source>` - 禁用配置源
+- `tools-cc status` - 查看项目状态
+
+### 配置管理
+- `tools-cc config set <key> <value>` - 设置配置
+- `tools-cc config get <key>` - 获取配置
+- `tools-cc config list` - 查看完整配置
+
+## 支持的 AI 工具
+
+| 工具 | 链接名称 |
+|------|----------|
+| iflow | `.iflow` |
+| claude | `.claude` |
+| codebuddy | `.codebuddy` |
+| opencode | `.opencode` |
+
+## 配置文件位置
+
+- **全局配置**: `~/.tools-cc/config.json`
+- **项目配置**: `项目/.toolscc/config.json`
+- **源存储目录**: `~/.tools-cc/sources`（可配置）
+
+## 核心类型
+
+```typescript
+// 源配置
+interface SourceConfig {
+  type: 'git' | 'local';
+  url?: string;
+  path?: string;
+}
+
+// 全局配置
+interface GlobalConfig {
+  sourcesDir: string;
+  sources: Record<string, SourceConfig>;
+}
+
+// 项目配置
+interface ProjectConfig {
+  sources: string[];
+  links: string[];
+}
+
+// Manifest 文件
+interface Manifest {
+  name: string;
+  version: string;
+  skills?: string[];
+  commands?: string[];
+  agents?: string[];
+}
+```
+
+## 开发约定
+
+### 代码风格
+- 使用 TypeScript strict 模式
+- 异步函数使用 async/await
+- 文件操作使用 fs-extra
+- 命令处理函数命名：`handle*`
+
+### 测试
+- 测试文件放在 `tests/` 目录，镜像 `src/` 结构
+- 使用 vitest 框架
+- 测试固件放在 `tests/fixtures/`
+
+### 命令添加
+1. 在 `src/commands/` 创建或修改命令处理文件
+2. 在 `src/index.ts` 注册新命令
+3. 添加相应的测试
+
+### 文档更新 [CHANGELOG.md](CHANGELOG.md)[README.md](README.md)
+- 更新文档时，请确保命令描述清晰、准确，并使用一致的格式
+- 添加新命令时，请更新命令列表和描述
+- 修改现有命令时，请更新相关命令的描述
+
+## 注意事项
+
+- 此项目运行在 Windows 系统，注意路径分隔符兼容性
+- 符号链接在 Windows 上可能需要管理员权限
+- 全局配置目录位于用户主目录下的 `.tools-cc`

package/CHANGELOG.md

@@ -0,0 +1,63 @@
+# 变更日志
+
+本项目的所有重要变更都将记录在此文件中。
+
+## [1.0.3] - 2026-02-26
+
+### Changed
+- 项目配置文件位置从 `tools-cc.json` 改为 `.toolscc/config.json`
+- 优化文档命令描述，明确区分全局和项目命令
+
+## [1.0.2] - 2026-02-26
+
+### Added
+- 新增 `tools-cc -s scan` 命令：扫描 sourcesDir 目录，自动发现并添加配置源
+- 新增 `tools-cc -s upgrade [name]` 命令别名：执行 git pull 更新配置源代码
+- 新增 `tools-cc update [sources...]` 命令：同步配置源内容到项目 .toolscc 目录
+
+### Changed
+- 优化帮助文档，添加工作流说明和命令对比表
+
+## [1.0.1] - 2026-02-25
+
+### Added
+- 补充 package.json 仓库相关元数据（repository、bugs、homepage）
+
+## [1.0.0] - 2026-02-25
+
+### Added
+- 项目初始化，基于 TypeScript + Commander 构建 CLI 框架
+- 全局配置管理模块
+  - `tools-cc -c set <key> <value>` 设置配置
+  - `tools-cc -c get <key>` 查看配置
+  - `tools-cc config list` 查看完整配置
+- 配置源管理模块
+  - `tools-cc -s add <name> <path-or-url>` 添加配置源（支持 Git URL 和本地路径）
+  - `tools-cc -s list` 列出所有配置源
+  - `tools-cc -s remove <name>` 移除配置源
+  - `tools-cc -s update [name]` 更新配置源（git pull）
+- 项目管理模块
+  - `tools-cc use [sources...]` 启用配置源并创建符号链接
+  - `tools-cc list` 列出已启用的配置源
+  - `tools-cc rm <source>` 禁用配置源
+  - `tools-cc status` 查看项目状态
+- 符号链接管理模块（支持 Windows Junction）
+- Manifest 加载和扫描模块
+- 中英双语帮助信息 (`tools-cc help`)
+- 单元测试覆盖（vitest）
+
+### Supported Tools
+| 工具 | 链接名称 |
+|------|----------|
+| iflow | `.iflow` |
+| claude | `.claude` |
+| codebuddy | `.codebuddy` |
+| opencode | `.opencode` |
+
+---
+
+## 版本说明
+
+- **主版本号**: 不兼容的 API 变更
+- **次版本号**: 向后兼容的功能新增
+- **修订号**: 向后兼容的问题修复

package/{readme.md → README.md}

@@ -173,6 +173,7 @@ my-skills/
 ```
 my-project/
 ├── .toolscc/                     # 实际内容目录
+│   ├── config.json               # 项目配置
 │   ├── skills/                   # 扁平化，带来源前缀
 │   │   └── my-skills-my-skill/
 │   ├── commands/
@@ -180,8 +181,7 @@ my-project/
 │   └── agents/
 │       └── my-skills/
 ├── .iflow -> .toolscc            # 符号链接
-├── .claude -> .toolscc
-└── tools-cc.json                 # 项目配置
+└── .claude -> .toolscc
 ```
 
 ## 配置文件
@@ -204,7 +204,7 @@ my-project/
 }
 ```
 
-### 项目配置 `项目/tools-cc.json`
+### 项目配置 `项目/.toolscc/config.json`
 
 ```json
 {

package/dist/commands/use.js

@@ -78,7 +78,7 @@ async function handleUse(sourceNames, options) {
         }
     }
     // 更新项目配置
-    const configFile = path_2.default.join(projectDir, 'tools-cc.json');
+    const configFile = (0, path_1.getProjectConfigPath)(projectDir);
     const config = await fs_extra_1.default.readJson(configFile);
     const existingLinks = config.links || [];
     config.links = [...new Set([...existingLinks, ...tools])];
@@ -117,7 +117,7 @@ async function handleStatus() {
     // 检查 sources
     console.log(`  Sources: ${sources.length > 0 ? sources.map(s => chalk_1.default.cyan(s)).join(', ') : chalk_1.default.gray('none')}`);
     // 检查 links
-    const configFile = path_2.default.join(projectDir, 'tools-cc.json');
+    const configFile = (0, path_1.getProjectConfigPath)(projectDir);
     if (await fs_extra_1.default.pathExists(configFile)) {
         const config = await fs_extra_1.default.readJson(configFile);
         console.log(`  Links:`);
@@ -134,7 +134,7 @@ async function handleStatus() {
 }
 async function handleProjectUpdate(sourceNames) {
     const projectDir = process.cwd();
-    const configFile = path_2.default.join(projectDir, 'tools-cc.json');
+    const configFile = (0, path_1.getProjectConfigPath)(projectDir);
     // 检查项目是否已初始化
     if (!(await fs_extra_1.default.pathExists(configFile))) {
         console.log(chalk_1.default.yellow('Project not initialized. Run `tools-cc use <source>` first.'));

package/dist/utils/path.d.ts

@@ -4,5 +4,5 @@ export declare const DEFAULT_CONFIG: {
     sourcesDir: string;
     sources: {};
 };
-export declare function getProjectConfigPath(projectDir: string): string;
 export declare function getToolsccDir(projectDir: string): string;
+export declare function getProjectConfigPath(projectDir: string): string;

package/dist/utils/path.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_CONFIG = exports.GLOBAL_CONFIG_FILE = exports.GLOBAL_CONFIG_DIR = void 0;
-exports.getProjectConfigPath = getProjectConfigPath;
 exports.getToolsccDir = getToolsccDir;
+exports.getProjectConfigPath = getProjectConfigPath;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 exports.GLOBAL_CONFIG_DIR = path_1.default.join(os_1.default.homedir(), '.tools-cc');
@@ -14,9 +14,9 @@ exports.DEFAULT_CONFIG = {
     sourcesDir: path_1.default.join(exports.GLOBAL_CONFIG_DIR, 'sources'),
     sources: {}
 };
-function getProjectConfigPath(projectDir) {
-    return path_1.default.join(projectDir, 'tools-cc.json');
-}
 function getToolsccDir(projectDir) {
     return path_1.default.join(projectDir, '.toolscc');
 }
+function getProjectConfigPath(projectDir) {
+    return path_1.default.join(getToolsccDir(projectDir), 'config.json');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tools-cc",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "tools-cc [options] <command> [args]",
   "main": "index.js",
   "directories": {

package/src/commands/use.ts

@@ -3,7 +3,7 @@ import inquirer from 'inquirer';
 import { useSource, unuseSource, listUsedSources, initProject } from '../core/project';
 import { getSourcePath, listSources } from '../core/source';
 import { createSymlink, isSymlink } from '../core/symlink';
-import { GLOBAL_CONFIG_DIR, getToolsccDir } from '../utils/path';
+import { GLOBAL_CONFIG_DIR, getToolsccDir, getProjectConfigPath } from '../utils/path';
 import fs from 'fs-extra';
 import path from 'path';
 
@@ -83,7 +83,7 @@ export async function handleUse(
   }
   
   // 更新项目配置
-  const configFile = path.join(projectDir, 'tools-cc.json');
+  const configFile = getProjectConfigPath(projectDir);
   const config = await fs.readJson(configFile);
   const existingLinks = config.links || [];
   config.links = [...new Set([...existingLinks, ...tools])];
@@ -131,7 +131,7 @@ export async function handleStatus(): Promise<void> {
   console.log(`  Sources: ${sources.length > 0 ? sources.map(s => chalk.cyan(s)).join(', ') : chalk.gray('none')}`);
   
   // 检查 links
-  const configFile = path.join(projectDir, 'tools-cc.json');
+  const configFile = getProjectConfigPath(projectDir);
   if (await fs.pathExists(configFile)) {
     const config = await fs.readJson(configFile);
     console.log(`  Links:`);
@@ -148,7 +148,7 @@ export async function handleStatus(): Promise<void> {
 
 export async function handleProjectUpdate(sourceNames?: string[]): Promise<void> {
   const projectDir = process.cwd();
-  const configFile = path.join(projectDir, 'tools-cc.json');
+  const configFile = getProjectConfigPath(projectDir);
   
   // 检查项目是否已初始化
   if (!(await fs.pathExists(configFile))) {

package/src/utils/path.ts

@@ -9,10 +9,10 @@ export const DEFAULT_CONFIG = {
   sources: {}
 };
 
-export function getProjectConfigPath(projectDir: string): string {
-  return path.join(projectDir, 'tools-cc.json');
-}
-
 export function getToolsccDir(projectDir: string): string {
   return path.join(projectDir, '.toolscc');
 }
+
+export function getProjectConfigPath(projectDir: string): string {
+  return path.join(getToolsccDir(projectDir), 'config.json');
+}