tools-cc 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 本项目的所有重要变更都将记录在此文件中。
 
+## [1.0.4] - 2026-02-28
+
+### Added
+- 新增英文版项目说明文档 README_en.md
+
+### Changed
+- 优化项目初始化与源码同步逻辑
+
 ## [1.0.3] - 2026-02-26
 
 ### Changed

package/CHANGELOG_en.md

@@ -0,0 +1,71 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.4] - 2026-02-28
+
+### Added
+- Added English version of project documentation README_en.md
+
+### Changed
+- Optimized project initialization and source synchronization logic
+
+## [1.0.3] - 2026-02-26
+
+### Changed
+- Changed project configuration file location from `tools-cc.json` to `.toolscc/config.json`
+- Improved documentation command descriptions, clearly distinguishing global and project commands
+
+## [1.0.2] - 2026-02-26
+
+### Added
+- Added `tools-cc -s scan` command: scan sourcesDir directory to auto-discover and add configuration sources
+- Added `tools-cc -s upgrade [name]` command alias: execute git pull to update configuration source code
+- Added `tools-cc update [sources...]` command: sync configuration source content to project .toolscc directory
+
+### Changed
+- Improved help documentation, added workflow guide and command comparison table
+
+## [1.0.1] - 2026-02-25
+
+### Added
+- Added package.json repository metadata (repository, bugs, homepage)
+
+## [1.0.0] - 2026-02-25
+
+### Added
+- Project initialization, built CLI framework based on TypeScript + Commander
+- Global configuration management module
+  - `tools-cc -c set <key> <value>` set configuration
+  - `tools-cc -c get <key>` get configuration
+  - `tools-cc config list` view complete configuration
+- Configuration source management module
+  - `tools-cc -s add <name> <path-or-url>` add configuration source (supports Git URL and local path)
+  - `tools-cc -s list` list all configuration sources
+  - `tools-cc -s remove <name>` remove configuration source
+  - `tools-cc -s update [name]` update configuration source (git pull)
+- Project management module
+  - `tools-cc use [sources...]` enable configuration sources and create symbolic links
+  - `tools-cc list` list enabled configuration sources
+  - `tools-cc rm <source>` disable configuration source
+  - `tools-cc status` view project status
+- Symbolic link management module (supports Windows Junction)
+- Manifest loading and scanning module
+- Bilingual help information (Chinese/English) (`tools-cc help`)
+- Unit test coverage (vitest)
+
+### Supported Tools
+| Tool | Link Name |
+|------|-----------|
+| iflow | `.iflow` |
+| claude | `.claude` |
+| codebuddy | `.codebuddy` |
+| opencode | `.opencode` |
+
+---
+
+## Versioning
+
+- **Major version**: Incompatible API changes
+- **Minor version**: Backwards-compatible functionality additions
+- **Patch version**: Backwards-compatible bug fixes

package/README.md

@@ -36,6 +36,13 @@ tools-cc -s list
 cd my-project
 tools-cc use my-skills -p iflow claude
 
+# 4a. 或使用部分引入（只引入需要的 skills/commands/agents）
+tools-cc use my-skills/skills/a-skill
+tools-cc use my-skills -ls                 # 交互式选择
+
+# 4b. 或从配置文件快速导入
+tools-cc use -c project-config.json
+
 # 5. 查看项目状态
 tools-cc status
 
@@ -99,11 +106,47 @@ tools-cc sources scan                     # 扫描 sourcesDir 目录，自动发
 ### 项目配置
 
 ```bash
-tools-cc use [sources...] [-p tools...]   # 启用配置源并创建符号链接
+tools-cc use [sources...] [options]       # 启用配置源并创建符号链接
 tools-cc update [sources...]              # 同步配置源内容到项目 .toolscc 目录
 tools-cc list                             # 列出已启用的配置源
 tools-cc rm <source>                      # 禁用配置源
 tools-cc status                           # 查看项目状态
+tools-cc export [options]                 # 导出项目或全局配置
+```
+
+#### `use` 命令详解
+
+```bash
+# 整源引入（全部 skills/commands/agents）
+tools-cc use my-skills
+tools-cc use my-skills -p iflow claude    # 指定工具链接
+
+# 部分引入（路径语法）
+tools-cc use my-skills/skills/a-skill     # 引入单个 skill
+tools-cc use my-skills/commands/test      # 引入单个 command
+tools-cc use my-skills/agents/reviewer    # 引入单个 agent
+tools-cc use my-skills/skills/a my-skills/commands/test  # 引入多项
+
+# 交互式选择（-ls 参数）
+tools-cc use my-skills -ls                # 分组展示，勾选引入
+
+# 从配置文件导入
+tools-cc use -c project-config.json       # 快速恢复项目配置
+
+# 使用 "." 表示当前项目已配置的源（只创建链接，不复制内容）
+tools-cc use . -p iflow claude
+```
+
+#### `export` 命令详解
+
+```bash
+# 导出项目配置（包含具体选择）
+tools-cc export                           # 导出到 .toolscc-export.json
+tools-cc export -o my-config.json         # 指定输出路径
+
+# 导出全局配置
+tools-cc export --global                  # 导出到 .toolscc-global-export.json
+tools-cc export --global -o global.json   # 指定输出路径
 ```
 
 ### Config 管理
@@ -208,11 +251,23 @@ my-project/
 
 ```json
 {
-  "sources": ["my-skills"],
+  "sources": {
+    "my-skills": {
+      "skills": ["a-skill", "b-skill"],
+      "commands": ["test"],
+      "agents": ["*"]
+    }
+  },
   "links": ["iflow", "claude"]
 }
 ```
 
+**说明：**
+- `sources` 记录每个源具体引入了哪些内容
+- `["*"]` 表示引入该类型全部内容
+- `[]` 表示不引入该类型任何内容
+```
+
 ## 许可证
 
 MIT

package/README_en.md

@@ -0,0 +1,218 @@
+# tools-cc
+
+A CLI tool for unified management of skills/commands/agents configurations across multiple AI programming tools (iflow, claude, codebuddy, opencode, etc.). Uses symbolic links to avoid duplicate configurations across tools.
+
+## Installation
+
+```bash
+# Install from npm
+npm install -g tools-cc
+
+# Or build from source
+git clone https://github.com/q759410559/tools-cc.git
+cd tools-cc
+npm install
+npm run build
+npm link
+```
+
+## Quick Start
+
+```bash
+# 1. Set configuration source storage location (optional, default is ~/.tools-cc/sources)
+tools-cc -c set sourcesDir D:/skills-hub-sources
+
+# 2. Add configuration sources (supports Git URL or local path)
+tools-cc -s add my-skills https://github.com/user/my-skills.git
+tools-cc -s add local-skills D:/path/to/local-skills
+
+# Or scan source directory to auto-discover and add configurations
+tools-cc -s scan
+
+# 3. View added configuration sources
+tools-cc -s list
+
+# 4. Enable configuration sources in a project and create links
+cd my-project
+tools-cc use my-skills -p iflow claude
+
+# 5. View project status
+tools-cc status
+
+# 6. View enabled configuration sources
+tools-cc list
+
+# 7. Update configuration sources (sync latest content from source directory to project)
+tools-cc update my-skills
+tools-cc update              # Update all
+
+# 8. Remove configuration source
+tools-cc rm my-skills
+```
+
+## Workflow Guide
+
+### Global Source Management vs Project Configuration
+
+| Command | Scope | Description |
+|---------|-------|-------------|
+| `tools-cc -s add/remove/list` | Global | Manage global configuration sources |
+| `tools-cc -s update/upgrade` | Global | git pull to update source code |
+| `tools-cc -s scan` | Global | Scan directory to discover new sources |
+| `tools-cc use/rm` | Project | Enable/disable sources in project |
+| `tools-cc update` | Project | Sync source content to project |
+
+### Typical Workflow
+
+```bash
+# Scenario 1: Configuration source has updates, need to sync to project
+tools-cc -s upgrade my-skills    # 1. git pull to update source code
+cd my-project
+tools-cc update my-skills        # 2. Sync to project .toolscc directory
+
+# Scenario 2: Batch update all sources
+tools-cc -s upgrade              # 1. Update all git sources
+cd my-project
+tools-cc update                  # 2. Sync all sources to project
+```
+
+## Command Reference
+
+### Source Management
+
+```bash
+# Shortcuts (-s)
+tools-cc -s add <name> <path-or-url>     # Add configuration source (Git URL or local path)
+tools-cc -s list                          # List all configuration sources (alias: -s ls)
+tools-cc -s remove <name>                 # Remove configuration source (alias: -s rm)
+tools-cc -s update [name]                 # git pull to update source code (alias: -s up, -s upgrade)
+tools-cc -s scan                          # Scan sourcesDir to auto-discover and add configuration sources
+
+# Full commands (sources)
+tools-cc sources add <name> <path-or-url> # Add configuration source
+tools-cc sources list                     # List all configuration sources (alias: sources ls)
+tools-cc sources remove <name>            # Remove configuration source (alias: sources rm)
+tools-cc sources update [name]            # git pull to update source code (alias: sources up, sources upgrade)
+tools-cc sources scan                     # Scan sourcesDir to auto-discover and add configuration sources
+```
+
+### Project Configuration
+
+```bash
+tools-cc use [sources...] [-p tools...]   # Enable configuration sources and create symbolic links
+tools-cc update [sources...]              # Sync configuration source content to project .toolscc directory
+tools-cc list                             # List enabled configuration sources
+tools-cc rm <source>                      # Disable configuration source
+tools-cc status                           # View project status
+```
+
+### Config Management
+
+```bash
+# Shortcuts (-c)
+tools-cc -c set <key> <value>             # Set configuration
+tools-cc -c get <key>                     # Get configuration
+
+# Full commands (config)
+tools-cc config set <key> <value>         # Set configuration
+tools-cc config get <key>                 # Get configuration
+tools-cc config list                      # View complete global configuration
+```
+
+### Help
+
+```bash
+tools-cc help                             # Display bilingual help (Chinese/English)
+tools-cc --help                           # Display command line help
+tools-cc --version                        # Display version number
+```
+
+## Supported Tools
+
+| Tool | Link Name |
+|------|-----------|
+| iflow | `.iflow` |
+| claude | `.claude` |
+| codebuddy | `.codebuddy` |
+| opencode | `.opencode` |
+
+## Configuration Source Structure
+
+A configuration source directory should contain the following structure:
+
+```
+my-skills/
+├── manifest.json          # Optional, describes component information
+├── skills/
+│   └── my-skill/
+│       └── SKILL.md
+├── commands/
+│   └── my-command.md
+└── agents/
+    └── my-agent.md
+```
+
+### manifest.json Format
+
+```json
+{
+  "name": "my-skills",
+  "version": "1.0.0",
+  "skills": ["my-skill"],
+  "commands": ["my-command"],
+  "agents": ["my-agent"]
+}
+```
+
+If `manifest.json` is not present, the CLI will automatically scan the directory structure to generate one.
+
+## Project Structure
+
+After using `tools-cc use`, the project directory structure:
+
+```
+my-project/
+├── .toolscc/                     # Actual content directory
+│   ├── config.json               # Project configuration
+│   ├── skills/                   # Flattened, with source prefix
+│   │   └── my-skills-my-skill/
+│   ├── commands/
+│   │   └── my-skills/
+│   └── agents/
+│       └── my-skills/
+├── .iflow -> .toolscc            # Symbolic link
+└── .claude -> .toolscc
+```
+
+## Configuration Files
+
+### Global Configuration `~/.tools-cc/config.json`
+
+```json
+{
+  "sourcesDir": "D:/skills-hub-sources",
+  "sources": {
+    "my-skills": {
+      "type": "git",
+      "url": "https://github.com/user/my-skills.git"
+    },
+    "local-skills": {
+      "type": "local",
+      "path": "D:/local-skills"
+    }
+  }
+}
+```
+
+### Project Configuration `project/.toolscc/config.json`
+
+```json
+{
+  "sources": ["my-skills"],
+  "links": ["iflow", "claude"]
+}
+```
+
+## License
+
+MIT

package/dist/commands/export.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 导出项目或全局配置
+ */
+export declare function handleExport(options: {
+    output?: string;
+    global?: boolean;
+}): Promise<void>;

package/dist/commands/export.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleExport = handleExport;
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const project_1 = require("../core/project");
+const config_1 = require("../core/config");
+const path_2 = require("../utils/path");
+/**
+ * 导出项目或全局配置
+ */
+async function handleExport(options) {
+    try {
+        if (options.global) {
+            // 导出全局配置
+            await exportGlobalConfig(options.output);
+        }
+        else {
+            // 导出项目配置
+            await exportProjectConfigCmd(options.output);
+        }
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.log(chalk_1.default.red(`✗ Export failed: ${message}`));
+        throw error;
+    }
+}
+/**
+ * 导出项目配置
+ */
+async function exportProjectConfigCmd(outputPath) {
+    const projectDir = process.cwd();
+    const outputFile = outputPath ?? path_1.default.join(projectDir, '.toolscc-export.json');
+    await (0, project_1.exportProjectConfig)(projectDir, outputFile);
+    console.log(chalk_1.default.green(`✓ Project config exported to: ${outputFile}`));
+}
+/**
+ * 导出全局配置
+ */
+async function exportGlobalConfig(outputPath) {
+    const projectDir = process.cwd();
+    const outputFile = outputPath ?? path_1.default.join(projectDir, '.toolscc-global-export.json');
+    const config = await (0, config_1.loadGlobalConfig)(path_2.GLOBAL_CONFIG_DIR);
+    const exportConfig = {
+        version: '1.0',
+        type: 'global',
+        config,
+        exportedAt: new Date().toISOString()
+    };
+    await fs_extra_1.default.writeJson(outputFile, exportConfig, { spaces: 2 });
+    console.log(chalk_1.default.green(`✓ Global config exported to: ${outputFile}`));
+}

package/dist/commands/use.d.ts

@@ -1,6 +1,22 @@
-export declare function handleUse(sourceNames: string[], options: {
+/**
+ * use 命令选项
+ */
+export interface UseOptions {
     projects?: string[];
-}): Promise<void>;
+    ls?: boolean;
+    config?: string;
+}
+/**
+ * 处理 use 命令
+ *
+ * 支持多种模式：
+ * 1. 配置导入模式: tools-cc use -c config.json
+ * 2. 交互选择模式: tools-cc use my-source -ls
+ * 3. 路径语法模式: tools-cc use my-source/skills/a-skill
+ * 4. 整体导入模式: tools-cc use my-source
+ * 5. 点模式: tools-cc use . (使用已配置源)
+ */
+export declare function handleUse(sourceSpecs: string[], options: UseOptions): Promise<void>;
 export declare function handleList(): Promise<void>;
 export declare function handleRemove(sourceName: string): Promise<void>;
 export declare function handleStatus(): Promise<void>;