@dayinxisheng/skillctl 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2026-03-05
+
+### Added
+- `CHANGELOG.md` - 项目变更日志
+
+### Changed
+- 改进 `README.md` 使用说明，添加更多示例和场景
+- 更新包名为 `@dayinxisheng/skillctl`（使用命名空间）
+- 添加 `publishConfig.access: public` 支持公开发布
+
+## [1.0.0] - 2026-03-05
+
+### Added
+- 初始发布
+- 激活/停用 skills（支持 user/project 级别）
+- 导入外部 skill 到项目
+- 定位 skill 实际位置
+- 查看激活状态和列表
+- 仓库路径配置管理
+- 跨平台支持（Windows/macOS/Linux）
+- TypeScript 类型定义

package/README.md

@@ -1,103 +1,246 @@
-# skillctl
+# @dayinxisheng/skillctl
 
-Claude Skills 管理工具 - TypeScript/JavaScript 版本
+> Claude Skills 管理工具 - 轻松管理你的 Claude Skills
 
 管理 Claude Skills 的激活状态和项目归档，通过软链接实现 skills 的灵活切换。
 
-## 安装
+## 📦 安装
 
 ```bash
-npm install -g skillctl
+npm install -g @dayinxisheng/skillctl
 ```
 
-或从源码安装：
+安装完成后，可以在任何目录使用 `skillctl` 命令。
+
+## 🚀 快速开始
+
+### 第一步：设置仓库路径
+
+告诉 skillctl 你的 skills 仓库在哪里（存储所有 skill 文件的目录）：
 
 ```bash
-git clone <repo-url>
-cd skillctl
-npm install
-npm run build
-npm link
+skillctl set-repo ~/my-skills
+```
+
+### 第二步：查看可用的 skills
+
+```bash
+skillctl all-list
+```
+
+输出示例：
 ```
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  项目中所有可用的 Skills
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-## 使用
+  brainstorming
+  frontend-design
+  pdf-tools
 
-### 设置仓库路径
+ℹ 共找到 3 个 skills
+  位置: ~/my-skills
+```
 
-首先设置 skills 仓库路径：
+### 第三步：激活 skill
 
 ```bash
-skillctl set-repo /path/to/your/skills/repository
+skillctl activate brainstorming
+```
+
+输出：
 ```
+✓ 已激活: brainstorming (user)
+```
+
+## 📚 核心概念
 
-### 激活 Skill
+### User vs Project 两级作用域
 
-将项目中的 skill 创建软链接到激活目录。
+skillctl 支持两个作用域：
+
+| 作用域 | 路径 | 说明 |
+|--------|------|------|
+| **User** | `~/.claude/skills/` | 全局可用，所有项目共享 |
+| **Project** | `./.claude/skills/` | 仅当前项目可用 |
+
+**示例场景：**
+- 团队共享的技能 → 用 Project 级别
+- 个人常用技能 → 用 User 级别
+
+## 🎯 常用命令
+
+### 1. 激活 Skill
 
 ```bash
-# 激活单个 skill 到 user 级别（默认）
-skillctl activate my-skill
+# 激活到 user 级别（默认）- 全局可用
+skillctl activate brainstorming
 
-# 激活到 project 级别
-skillctl activate -p my-skill
+# 激活到 project 级别 - 仅当前项目
+skillctl activate -p brainstorming
 
 # 批量激活所有 skills
 skillctl activate --all
+skillctl activate -u --all  # 明确指定 user 级别
+skillctl activate -p --all  # 明确指定 project 级别
 ```
 
-### 停用 Skill
-
-删除软链接，停用已激活的 skill。
+### 2. 停用 Skill
 
 ```bash
-# 停用单个 skill
-skillctl deactivate my-skill
+# 停用 user 级别的 skill
+skillctl deactivate brainstorming
 
-# 批量停用所有 skills
+# 停用 project 级别的 skill
+skillctl deactivate -p brainstorming
+
+# 批量停用所有
 skillctl deactivate --all
 ```
 
-### 导入 Skill
+### 3. 查看状态
+
+```bash
+# 查看所有 skills 的激活状态（表格形式）
+skillctl status
+```
 
-将外部的 skill 导入到项目的 `skills/` 目录。
+输出示例：
+```
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  Skills 激活状态
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Skill                 User       Project
+──────────────────────────── ────────── ───────────
+brainstorming         ✓          ✗
+frontend-design       ✗          ✓
+pdf-tools             ✓          ✓
+
+ℹ 共 3 个 skills
+  ✓ = 已激活  ✗ = 未激活
+```
 
 ```bash
-# 从 user 级别导入
-skillctl import my-skill
+# 只看已激活的 skills
+skillctl list
+```
 
-# 从 project 级别导入
-skillctl import -p my-skill
+输出示例：
+```
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  当前激活的 Skills
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+全局 (~/.claude/skills):
+  brainstorming → ~/my-skills/brainstorming
+  pdf-tools → ~/my-skills/pdf-tools
+ℹ 共 2 个
+
+本地 (./.claude/skills):
+  frontend-design → ~/my-skills/frontend-design
+ℹ 共 1 个
 ```
 
-### 查看状态
+### 4. 导入 Skill
+
+将外部开发的 skill 导入到你的项目仓库：
 
 ```bash
-# 查看激活状态表
-skillctl status
+# 假设你有一个 skill 在 ~/.claude/skills/my-new-skill
+# 将其导入到项目仓库
+skillctl import my-new-skill
+```
 
-# 列出当前激活的 skills
-skillctl list
+这会：
+1. 将 skill 移动到你的项目仓库
+2. 在原位置创建软链接
 
-# 列出所有可用的 skills
-skillctl all-list
+### 5. 定位 Skill
 
-# 定位 skill 的实际位置
-skillctl locate my-skill
+查找 skill 的实际存储位置：
+
+```bash
+skillctl locate brainstorming
+```
+
+输出示例：
+```
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  Skill 定位: brainstorming
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  全局: ~/.claude/skills/brainstorming → ~/my-skills/brainstorming (软链接)
 ```
 
-### 配置管理
+## ⚙️ 配置管理
 
 ```bash
-# 查看配置信息
+# 查看当前配置
 skillctl config
+```
+
+输出示例：
+```
+ℹ 配置文件: ~/.config/skillctl/config.json
+ℹ 仓库路径: ~/my-skills
+```
+
+```bash
+# 更新仓库路径
+skillctl set-repo /new/path/to/skills
 
 # 查看当前仓库路径
 skillctl get-repo
 ```
 
-## 开发
+## 💡 实用场景
+
+### 场景 1：新项目设置
+
+```bash
+# 1. 进入项目目录
+cd ~/my-project
+
+# 2. 激活项目需要的 skills
+skillctl activate -p frontend-design
+skillctl activate -p brainstorming
+
+# 3. 验证
+skillctl list
+```
+
+### 场景 2：切换技能集
 
 ```bash
+# 停用当前所有 skills
+skillctl deactivate --all
+
+# 激活新的技能集
+skillctl activate pdf-tools
+skillctl activate docx-tools
+```
+
+### 场景 3：分享你的 skill
+
+```bash
+# 1. 导入你的 skill 到项目仓库
+skillctl import my-awesome-skill
+
+# 2. 提交到 git
+cd ~/my-skills
+git add skills/my-awesome-skill
+git commit -m "Add my-awesome-skill"
+git push
+```
+
+## 🛠️ 开发
+
+```bash
+# 克隆项目
+git clone <repo-url>
+cd skillctl
+
 # 安装依赖
 npm install
 
@@ -107,6 +250,9 @@ npm run dev
 # 构建
 npm run build
 
+# 本地测试
+npm link
+
 # 运行测试
 npm test
 
@@ -115,33 +261,42 @@ npm run lint
 npm run lint:fix
 ```
 
-## 项目结构
+## 📁 项目结构
 
 ```
 src/
 ├── index.ts           # CLI 入口
 ├── commands/          # 命令处理器
-│   ├── activate.ts
-│   ├── deactivate.ts
-│   ├── import.ts
-│   ├── locate.ts
-│   ├── status.ts
-│   ├── list.ts
-│   ├── all-list.ts
-│   ├── set-repo.ts
-│   └── config.ts
+│   ├── activate.ts    # 激活命令
+│   ├── deactivate.ts  # 停用命令
+│   ├── import.ts      # 导入命令
+│   ├── locate.ts      # 定位命令
+│   ├── status.ts      # 状态命令
+│   ├── list.ts        # 列表命令
+│   ├── all-list.ts    # 全部列表命令
+│   ├── set-repo.ts    # 设置仓库命令
+│   └── config.ts      # 配置命令
 ├── lib/              # 核心业务逻辑
-│   ├── config-manager.ts
-│   ├── link-handler.ts
-│   └── skill-manager.ts
+│   ├── config-manager.ts  # 配置管理
+│   ├── link-handler.ts    # 软链接处理
+│   └── skill-manager.ts   # Skill 管理
 ├── utils/            # 工具函数
-│   ├── output.ts
-│   ├── errors.ts
-│   └── platform.ts
-└── types/            # 类型定义
+│   ├── output.ts      # 彩色输出
+│   ├── errors.ts      # 错误类型
+│   └── platform.ts    # 平台检测
+└── types/            # TypeScript 类型定义
     └── index.ts
 ```
 
-## 许可证
+## 📄 许可证
+
+MIT License © 2026 hrjlab
+
+## 📝 变更日志
+
+查看 [CHANGELOG.md](CHANGELOG.md) 了解版本更新历史。
+
+## 🔗 相关链接
 
-MIT
+- [npm 包](https://www.npmjs.com/package/@dayinxisheng/skillctl)
+- [问题反馈](<your-repo-issues>)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dayinxisheng/skillctl",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Claude Skills 管理工具 - 管理 Claude Skills 的激活状态和项目归档",
   "main": "dist/index.js",
   "bin": {
@@ -46,7 +46,8 @@
   "files": [
     "dist",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "publishConfig": {
     "access": "public"