mirror of
https://github.com/iflytek/skillhub.git
synced 2026-08-28 11:25:00 +00:00
a14d89d8c9
变更摘要： - doctor 命令重构：从重建改为扫描并合并语义，保留扫描范围外的条目 - 修复字段命名：itemsRestored → itemsScanned/itemsPreserved，语义更清晰 - 改进用户提示：输出区分扫描到的和保留的条目，帮助文档补充保留行为说明 - 补充代码注释：说明同 slug 不同 installDir 允许并存的设计意图 - 统一错误码：download/handleJsonResponse 的非 2xx 响应统一使用 EXIT.generic - 新增测试覆盖：合并场景、刷新场景、冲突不删除无关条目等边界情况 关键文件： - cli/src/services/doctor-service.ts - cli/src/commands/doctor.ts - cli/src/commands/help.ts - cli/test/unit/services/doctor-service.test.ts - cli/test/integration/doctor-command.test.ts
161 lines
3.8 KiB
Markdown
161 lines
3.8 KiB
Markdown
# SkillHub CLI
|
|
|
|
Manage and install skills for AI coding agents.
|
|
|
|
SkillHub is an enterprise-grade, self-hosted skill registry that enables teams to discover, share, and install reusable skills for AI coding agents like Claude Code. This CLI provides a seamless interface to interact with SkillHub registries.
|
|
|
|
## 📦 Installation
|
|
|
|
```bash
|
|
npm install -g @astron-team/skillhub
|
|
```
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Using the default registry
|
|
|
|
```bash
|
|
# Login to the default registry
|
|
skillhub login
|
|
|
|
# Search for skills
|
|
skillhub search react
|
|
|
|
# Install a skill
|
|
skillhub install @astron-team/react-component-builder
|
|
|
|
# List installed skills
|
|
skillhub list
|
|
```
|
|
|
|
### Using a custom registry
|
|
|
|
```bash
|
|
# Login to a custom registry
|
|
skillhub login --registry https://skillhub.yourcompany.com
|
|
|
|
# After login, other commands will use the same registry
|
|
skillhub search react
|
|
skillhub install @yourorg/custom-skill
|
|
```
|
|
|
|
You can also set a default custom registry in your shell:
|
|
|
|
**🐧 Linux/macOS (Bash/Zsh):**
|
|
```bash
|
|
export SKILLHUB_REGISTRY=https://skillhub.yourcompany.com
|
|
```
|
|
|
|
**🪟 Windows (PowerShell):**
|
|
```powershell
|
|
$env:SKILLHUB_REGISTRY="https://skillhub.yourcompany.com"
|
|
```
|
|
|
|
**🪟 Windows (CMD):**
|
|
```cmd
|
|
set SKILLHUB_REGISTRY=https://skillhub.yourcompany.com
|
|
```
|
|
|
|
## 📚 Commands
|
|
|
|
### 🔐 Authentication
|
|
|
|
- `skillhub login [--registry <url>]` - Authenticate with a SkillHub registry
|
|
- `skillhub logout [--registry <url>]` - Remove stored credentials
|
|
|
|
### 🎯 Skill Management
|
|
|
|
- `skillhub search <query>` - Search for skills in the registry
|
|
- `skillhub install <skill-name>` - Install a skill to ~/.claude/skills/
|
|
- `skillhub uninstall <skill-name>` - Remove an installed skill
|
|
- `skillhub list` - List all installed skills
|
|
- `skillhub info <skill-name>` - Show detailed information about a skill
|
|
|
|
### 🛠️ Utilities
|
|
|
|
- `skillhub version` - Display CLI version
|
|
- `skillhub help` - Show help information
|
|
- `skillhub doctor [--json]` - Scan the current project for installed skills and merge findings into the local inventory. Existing entries outside the scan are preserved; conflicts are reported but unrelated records are not deleted.
|
|
|
|
## 💡 Examples
|
|
|
|
### Search and install a skill
|
|
|
|
```bash
|
|
# Search for React-related skills
|
|
skillhub search react
|
|
|
|
# Install a specific skill
|
|
skillhub install @astron-team/react-component-builder
|
|
|
|
# Verify installation
|
|
skillhub list
|
|
```
|
|
|
|
### Manage installed skills
|
|
|
|
```bash
|
|
# View details about an installed skill
|
|
skillhub info @astron-team/react-component-builder
|
|
|
|
# Uninstall a skill
|
|
skillhub uninstall @astron-team/react-component-builder
|
|
```
|
|
|
|
### Work with custom registries
|
|
|
|
```bash
|
|
# Login to your private registry
|
|
skillhub login --registry https://skillhub.yourcompany.com
|
|
|
|
# After login, search and install work automatically
|
|
skillhub search internal-tools
|
|
skillhub install @yourorg/internal-skill
|
|
```
|
|
|
|
## 🌐 Registry
|
|
|
|
### Default registry
|
|
|
|
By default, the CLI connects to the public SkillHub registry at `https://skill.xfyun.cn`.
|
|
|
|
### Custom registry
|
|
|
|
Organizations can deploy their own private SkillHub instance. You can point the CLI to a custom registry:
|
|
|
|
**Per-command (recommended for one-time use):**
|
|
```bash
|
|
skillhub login --registry https://skillhub.yourcompany.com
|
|
```
|
|
|
|
**Shell-level default (persistent across commands):**
|
|
|
|
🐧 Linux/macOS:
|
|
```bash
|
|
export SKILLHUB_REGISTRY=https://skillhub.yourcompany.com
|
|
```
|
|
|
|
🪟 Windows PowerShell:
|
|
```powershell
|
|
$env:SKILLHUB_REGISTRY="https://skillhub.yourcompany.com"
|
|
```
|
|
|
|
🪟 Windows CMD:
|
|
```cmd
|
|
set SKILLHUB_REGISTRY=https://skillhub.yourcompany.com
|
|
```
|
|
|
|
### Skill namespaces
|
|
|
|
Skills are namespaced by organization to prevent naming conflicts:
|
|
|
|
- `@astron-team/skill-name` - Skills from the Astron team
|
|
- `@yourorg/skill-name` - Skills from your organization
|
|
|
|
When installing skills, always include the full namespaced name.
|
|
|
|
## 📄 License
|
|
|
|
Apache-2.0
|
|
|
|
Copyright 2026 iFlytek Co., Ltd.
|