@sstar/skill-install 1.0.0 → 1.1.0

package/README.md

@@ -1,180 +1,180 @@
-# Agent Skill Installer
+# Agent Skill 安装工具
 
-A command-line tool for installing Agent Skills from various sources (public URLs, Wiki with authentication, or local archive files). Automatically downloads, extracts, validates, and installs skills for **Claude Code** or **Codex**.
+命令行工具，用于从多种来源（公开 URL、需要认证的 Wiki 或本地归档文件）安装 Agent Skills。自动下载、解压、验证并安装技能到 **Claude Code** 或 **Codex**。
 
-## Features
+## 功能特性
 
-- **Multi-tool support**: Works with both Claude Code (`~/.claude/skills/`) and Codex (`~/.codex/skills/`)
-- **Auto-detect source**: Automatically detects if the source is a public URL, Wiki URL (with auth), or local file
-- **Multiple archive formats**: Supports `.zip` and `.tar.gz` archives
-- **Strict validation**: Validates that archives contain a valid `SKILL.md` with required frontmatter
-- **Wiki authentication**: Supports authentication with internal Confluence Wiki
-- **Skill management**: List installed skills and uninstall them
-- **Interactive prompts**: Choose between global/local directories and AI tools
-- **Self-signed certificates**: Built-in support for corporate SSL certificates
+- **多工具支持**：同时支持 Claude Code (`~/.claude/skills/`) 和 Codex (`~/.codex/skills/`)
+- **自动检测来源**：自动识别来源类型（公开 URL、需认证的 Wiki URL 或本地文件）
+- **多种归档格式**：支持 `.zip` 和 `.tar.gz` 归档文件
+- **严格验证**：验证归档包含有效的 `SKILL.md` 文件及必需的 frontmatter
+- **Wiki 认证**：支持内部 Confluence Wiki 的身份认证
+- **技能管理**：列出已安装的技能并支持卸载
+- **交互式提示**：可选择全局/本地目录和 AI 工具
+- **自签名证书**：内置支持企业 SSL 证书
 
-## What are Skills?
+## 什么是 Skills？
 
-Skills are a lightweight, open format for extending AI agent capabilities with specialized knowledge and workflows. At its core, a skill is a folder containing a `SKILL.md` file with metadata (`name` and `description`) and instructions.
+Skills 是一种轻量级的开放格式，用于通过专业知识和工作流扩展 AI 代理的能力。本质上，一个 skill 是一个包含 `SKILL.md` 文件的文件夹，该文件包含元数据（`name` 和 `description`）和指令。
 
-Learn more at: https://agentskills.io/what-are-skills
+了解更多：https://agentskills.io/what-are-skills
 
-## Installation
+## 安装
 
 ```bash
 cd /home/ekko.bao/work/tools/wiki_download
 npm install
 npm run build
-npm link  # Optional: for global installation
+npm link  # 可选：全局安装
 ```
 
-## Usage
+## 使用方法
 
 ```bash
-# Install with interactive AI tool and directory selection
+# 交互式安装（提示选择 AI 工具和目录）
 skill-install install https://github.com/user/repo/archive/main.zip
 
-# Install for specific AI tool (skip prompt)
+# 指定 AI 工具安装（跳过提示）
 skill-install -t claude install https://github.com/user/repo/archive/main.zip
 skill-install -t codex install https://github.com/user/repo/archive/main.zip
 
-# Install to global directory explicitly
+# 显式安装到全局目录
 skill-install install https://example.com/skill.zip --global
 
-# Install to local directory explicitly
+# 显式安装到本地目录
 skill-install install https://example.com/skill.zip --local
 
-# Install with custom directory
+# 安装到自定义目录
 skill-install -s /path/to/skills install https://example.com/skill.zip
 
-# Install from Wiki with authentication
+# 从需要认证的 Wiki 安装
 skill-install install https://wiki.company.com/download/attachments/123/skill.zip -u username
 
-# Install from a local archive file
+# 从本地归档文件安装
 skill-install install ./my-skill.zip
 
-# List installed skills (prompts for AI tool)
+# 列出已安装的技能（提示选择 AI 工具）
 skill-install list
 
-# List installed skills for specific AI tool (skip prompt)
+# 列出指定 AI 工具的技能（跳过提示）
 skill-install -t claude list
 skill-install -t codex list
 
-# List skills from both global and local directories
+# 列出全局和本地目录的所有技能
 skill-install list --all
 
-# Uninstall a skill (prompts for AI tool)
+# 卸载技能（提示选择 AI 工具）
 skill-install uninstall my-skill
 
-# Uninstall from specific AI tool (skip prompt)
+# 从指定 AI 工具卸载（跳过提示）
 skill-install -t claude uninstall my-skill
 skill-install -t codex uninstall my-skill
 
-# Force reinstall if skill already exists
+# 技能已存在时强制重新安装
 skill-install install ./my-skill.zip --force
 ```
 
-## Options
+## 命令选项
 
-### Global Options
-| Option | Description |
-|--------|-------------|
-| `-t, --tool <tool>` | AI tool: `claude` or `codex` (skip prompt if specified) |
-| `-s, --skills-dir <path>` | Custom skills directory |
-| `-v, --verbose` | Enable verbose logging |
-| `-h, --help` | Display help |
+### 全局选项
+| 选项 | 描述 |
+|------|------|
+| `-t, --tool <tool>` | AI 工具：`claude` 或 `codex`（指定后跳过提示） |
+| `-s, --skills-dir <path>` | 自定义技能目录 |
+| `-v, --verbose` | 启用详细日志 |
+| `-h, --help` | 显示帮助信息 |
 
-**Note**: If `-t` is not specified, the tool will prompt interactively to choose between Claude Code and Codex.
+**注意**：如果未指定 `-t`，工具将提示交互选择 Claude Code 或 Codex。
 
-### Install Command
-| Option | Description |
-|--------|-------------|
-| `<source>` | URL or local file path to skill archive |
-| `-g, --global` | Install to global directory (`~/.claude/skills/` or `~/.codex/skills/`) |
-| `-l, --local` | Install to local directory (`./.claude/skills/` or `./.codex/skills/`) |
-| `-u, --username <username>` | Wiki username (for Wiki URLs) |
-| `-p, --password <password>` | Wiki password (or use env var) |
-| `--allow-self-signed` | Allow self-signed SSL certificates (default: true) |
-| `-f, --force` | Reinstall if skill already exists |
+### install 命令
+| 选项 | 描述 |
+|------|------|
+| `<source>` | 技能归档的 URL 或本地文件路径 |
+| `-g, --global` | 安装到全局目录 (`~/.claude/skills/` 或 `~/.codex/skills/`) |
+| `-l, --local` | 安装到本地目录 (`./.claude/skills/` 或 `./.codex/skills/`) |
+| `-u, --username <username>` | Wiki 用户名（用于 Wiki URL） |
+| `-p, --password <password>` | Wiki 密码（或使用环境变量） |
+| `--allow-self-signed` | 允许自签名 SSL 证书（默认：true） |
+| `-f, --force` | 技能已存在时重新安装 |
 
-**Note**: If neither `-g` nor `-l` nor `-s` is specified, the tool will prompt interactively to choose between global and local directories.
+**注意**：如果未指定 `-g`、`-l` 或 `-s`，工具将提示交互选择全局或本地目录。
 
-### List Command
-| Option | Description |
-|--------|-------------|
-| `-a, --all` | List skills from both global and local directories |
+### list 命令
+| 选项 | 描述 |
+|------|------|
+| `-a, --all` | 列出全局和本地目录的所有技能 |
 
-### Uninstall Command
-| Option | Description |
-|--------|-------------|
-| `[name]` | Name of the skill to uninstall (optional - leave empty to select from list) |
-| `-y, --yes` | Skip confirmation prompt |
+### uninstall 命令
+| 选项 | 描述 |
+|------|------|
+| `[name]` | 要卸载的技能名称（可选 - 留空可从列表中选择） |
+| `-y, --yes` | 跳过确认提示 |
 
-**Note**: If no skill name is provided, the tool will display all installed skills and allow you to select which ones to uninstall by entering numbers separated by spaces (e.g., `1 3 5`).
+**注意**：如果未提供技能名称，工具将显示所有已安装的技能并允许通过输入数字来选择要卸载的技能（例如 `1 3 5`）。
 
-## Environment Variables
+## 环境变量
 
-| Variable | Description |
-|----------|-------------|
-| `WIKI_USERNAME` | Default Wiki username |
-| `WIKI_PASSWORD` | Default Wiki password |
+| 变量 | 描述 |
+|------|------|
+| `WIKI_USERNAME` | 默认 Wiki 用户名 |
+| `WIKI_PASSWORD` | 默认 Wiki 密码 |
 
-## Skill Validation
+## 技能验证
 
-A valid skill must have a `SKILL.md` file at the root with YAML frontmatter containing:
+有效的技能必须在根目录包含 `SKILL.md` 文件，其中包含 YAML frontmatter：
 
 ```yaml
 ---
 name: my-skill
-description: A brief description of what this skill does
+description: 对该技能功能的简要描述
 ---
 
 # My Skill
 
-Instructions for the agent...
+给代理的指令...
 ```
 
-The tool validates:
-- `SKILL.md` exists
-- YAML frontmatter is present (wrapped in `---`)
-- `name` field is present
-- `description` field is present
+工具会验证：
+- `SKILL.md` 文件存在
+- YAML frontmatter 存在（用 `---` 包裹）
+- `name` 字段存在
+- `description` 字段存在
 
-## Skill Directory Structure
+## 技能目录结构
 
-Skills can be installed to different locations based on the AI tool:
+根据 AI 工具的不同，技能可以安装到不同位置：
 
 ### Claude Code
-- **Global**: `~/.claude/skills/` - Available to all projects
-- **Local**: `./.claude/skills/` - Project-specific
+- **全局**：`~/.claude/skills/` - 所有项目可用
+- **本地**：`./.claude/skills/` - 项目特定
 
 ### Codex
-- **Global**: `~/.codex/skills/` - Available to all projects
-- **Local**: `./.codex/skills/` - Project-specific
+- **全局**：`~/.codex/skills/` - 所有项目可用
+- **本地**：`./.codex/skills/` - 项目特定
 
-### Directory Selection
-- **Global**: Use `--global` flag or select "1" when prompted (recommended for commonly used skills)
-- **Local**: Use `--local` flag or select "2" when prompted (recommended for project-specific skills)
-- **Custom**: Use `-s /path/to/skills` for a custom location
+### 目录选择
+- **全局**：使用 `--global` 标志或提示时选择 "1"（推荐用于常用技能）
+- **本地**：使用 `--local` 标志或提示时选择 "2"（推荐用于项目特定技能）
+- **自定义**：使用 `-s /path/to/skills` 指定自定义位置
 
-A typical installed skill:
+典型的已安装技能结构：
 
 ```
 ~/.claude/skills/my-skill/
-├── SKILL.md          # Required: instructions + metadata
-├── scripts/          # Optional: executable code
-├── references/       # Optional: documentation
-└── assets/           # Optional: templates, resources
+├── SKILL.md          # 必需：指令 + 元数据
+├── scripts/          # 可选：可执行代码
+├── references/       # 可选：文档
+└── assets/           # 可选：模板、资源
 ```
 
-## Examples
+## 使用示例
 
-### Interactive installation (prompts for AI tool and directory)
+### 交互式安装（提示选择 AI 工具和目录）
 
 ```bash
 skill-install install https://github.com/user/repo/archive/main.zip
 
-# Output:
+# 输出：
 # Select AI tool:
 #   1. Claude Code (~/.claude/skills/)
 #   2. Codex      (~/.codex/skills/)
@@ -188,67 +188,67 @@ skill-install install https://github.com/user/repo/archive/main.zip
 # Choose [1/2]: 1
 ```
 
-### Install for specific AI tool (skip prompt)
+### 为指定 AI 工具安装（跳过提示）
 
 ```bash
-# Install for Claude Code
+# 为 Claude Code 安装
 skill-install -t claude install https://example.com/skill.zip
 
-# Install for Codex
+# 为 Codex 安装
 skill-install -t codex install https://example.com/skill.zip
 
-# Install to Codex global directory
+# 安装到 Codex 全局目录
 skill-install -t codex install https://example.com/skill.zip --global
 ```
 
-### Install to specific directory
+### 安装到指定目录
 
 ```bash
-# Install to global directory
+# 安装到全局目录
 skill-install install https://example.com/skill.zip --global
 
-# Install to local directory
+# 安装到本地目录
 skill-install install https://example.com/skill.zip --local
 
-# Install to custom directory
+# 安装到自定义目录
 skill-install -s /custom/path install https://example.com/skill.zip
 ```
 
-### Install from Wiki
+### 从 Wiki 安装
 
 ```bash
 skill-install install "https://wiki.company.com/download/attachments/12345/skill.zip?api=v2" -u john.doe
 ```
 
-### Install from local file
+### 从本地文件安装
 
 ```bash
 skill-install install ~/Downloads/my-skill.tar.gz
 ```
 
-### List and uninstall
+### 列出和卸载
 
 ```bash
-# List skills (prompts for AI tool)
+# 列出技能（提示选择 AI 工具）
 skill-install list
 
-# List skills for specific AI tool (skip prompt)
+# 列出指定 AI 工具的技能（跳过提示）
 skill-install -t claude list
 skill-install -t codex list
 
-# List skills from both directories
+# 列出两个目录的所有技能
 skill-install -t claude list --all
 
-# Uninstall a specific skill (prompts for AI tool)
+# 卸载指定技能（提示选择 AI 工具）
 skill-install uninstall my-skill
 
-# Uninstall without prompts (specify AI tool and skip confirmation)
+# 无提示卸载（指定 AI 工具并跳过确认）
 skill-install -t codex uninstall my-skill -y
 
-# Interactive uninstall (select from list)
+# 交互式卸载（从列表选择）
 skill-install uninstall
 
-# Output:
+# 输出：
 # Select AI tool:
 #   1. Claude Code (~/.claude/skills/)
 #   2. Codex      (~/.codex/skills/)
@@ -270,27 +270,27 @@ skill-install uninstall
 # Selected skills: repo-git, pdf-processing
 ```
 
-## Project Structure
+## 项目结构
 
 ```
 src/
-├── cli.ts                    # CLI entry point
+├── cli.ts                    # CLI 入口
 ├── installer/
-│   └── install-service.ts    # Core installation logic
+│   └── install-service.ts    # 核心安装逻辑
 ├── download/
-│   └── download-manager.ts   # Download manager (wiki + public)
+│   └── download-manager.ts   # 下载管理器（wiki + 公共）
 ├── archive/
-│   └── archive-extractor.ts  # Archive extraction (ZIP, tar.gz)
+│   └── archive-extractor.ts  # 归档解压（ZIP、tar.gz）
 ├── source/
-│   └── source-detector.ts    # Source type detection
+│   └── source-detector.ts    # 来源类型检测
 ├── skills/
-│   ├── skills-manager.ts     # List/uninstall operations
-│   └── skill-validator.ts    # SKILL.md validation
-├── auth/                     # Wiki authentication
-├── http/                     # HTTP client with cookies
-└── core/                     # Error handling & logging
+│   ├── skills-manager.ts     # 列表/卸载操作
+│   └── skill-validator.ts    # SKILL.md 验证
+├── auth/                     # Wiki 认证
+├── http/                     # 带 Cookie 的 HTTP 客户端
+└── core/                     # 错误处理和日志
 ```
 
-## License
+## 许可证
 
 MIT