# BirdmanToolKit

**Repository Path**: birdman1992/birdman-tool-kit

## Basic Information

- **Project Name**: BirdmanToolKit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-08
- **Last Updated**: 2026-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Birdman Tool Kit

统一仓库，用于开发、分发 Halo 技能、自动化应用和 MCP 服务器配置。同时提供 Claude Code 插件市场。

## 安装方式

### 原生 Claude Code

```
/plugin marketplace add https://gitee.com/birdman1992/birdman-tool-kit.git
/plugin install birdman-tool-kit@birdman-tool-kit
```

> **前置条件：** 需安装 `claude` CLI。Halo 用户请确保 `claude.exe` 位于 `C:\Users\<用户名>\.local\bin\claude.exe` 或在系统 PATH 中。

### Halo 应用商店（一键安装，推荐）

在 Halo 的 `config.json` 中添加注册表源（`appStore.registries`）：

```json
{
  "id": "birdman-tool-kit",
  "name": "birdman-tool-kit",
  "url": "<raw-url>/registry/halo",
  "enabled": true,
  "sourceType": "claude-skills"
}
```

**各平台 URL：**

| 平台 | Raw URL |
|------|---------|
| Gitee | `https://gitee.com/birdman1992/birdman-tool-kit/raw/master` |

重启 Halo 后，技能出现在应用商店中，一键安装。

## 离线环境部署

适用于无法访问 Gitee 的内部网络（仅 GitLab + 局域网）。

### 第一步：导入代码

从联网机器打包，拿到离线环境导入：

```bash
# 联网机器
git clone https://gitee.com/birdman1992/birdman-tool-kit.git
cd birdman-tool-kit
git bundle create birdman-tool-kit.bundle --all

# 离线环境
git clone birdman-tool-kit.bundle birdman-tool-kit
cd birdman-tool-kit
git remote add origin https://gitlab.internal/<group>/birdman-tool-kit.git
git push -u origin master
```

### 第二步：生成注册表

```bash
cd birdman-tool-kit
npm install

# 生成 Halo 注册表（download_url 指向你的 GitLab Pages 地址）
REPO_RAW_BASE="https://<username>.gitlab.internal/birdman-tool-kit" \
REPO_BRANCH="master" \
  npm run build:halo-registry
```

生成产物：`registry/halo/index.json` + 23 个 `registry/halo/specs/*.json`。

### 第三步：提供 HTTP 访问

**方式一：GitLab Pages（推荐，长期运行）**

`.gitlab-ci.yml` 已包含在仓库中，直接推送触发 CI/CD 自动部署：

```bash
git push origin master
```

CI/CD 完成后，Halo 配置：

```json
{
  "url": "https://<username>.gitlab.internal/birdman-tool-kit/registry/halo",
  "sourceType": "claude-skills"
}
```

**方式二：内网 HTTP 服务器（快速验证）**

在任意机器上一键启动：

```bash
npm run serve
# → http://192.168.x.x:18770
```

Halo 配置：

```json
{
  "url": "http://192.168.x.x:18770",
  "sourceType": "claude-skills"
}
```

### 第四步：配置 Halo

**关闭 Halo**，编辑 `config.json`，在 `appStore.registries` 中添加上述 JSON 配置，然后启动 Halo。

> **提示：** 建议先用方式二（`npm run serve`）快速验证一切正常，再推送触发 GitLab Pages 做长期部署。

### Halo CLI 安装

```bash
npm run halo:install skill <slug>
```

复制 JSON 输出，在 Halo 中通过 `mcp__halo-apps__skill_manage` 工具安装。

详见 [INSTALL.md](INSTALL.md)（含离线 GitLab 部署说明）。

## 目录结构

- `skills/` — 技能源文件和模板（23 个技能）
- `apps/` — 自动化应用源文件和模板
- `mcps/` — MCP 服务器配置
- `registry/` — 安装和发现索引（含 `halo/` 子目录用于 Halo 应用商店）
- `scripts/` — 构建、校验和安装工具
- `docs/` — 规划、规格说明和仓库指引
- `.claude-plugin/marketplace.json` — Claude Code 插件市场清单

## 脚本

| 命令 | 说明 |
|------|------|
| `npm run build:registry` | 从仓库内容构建注册表索引 |
| `npm run build:halo-registry` | 生成 Halo 应用商店注册表（`registry/halo/index.json` + spec 文件） |
| `npm run validate:registry` | 校验注册表结构和数据 |
| `npm run check` | 执行构建 + 校验流程 |
| `npm run halo:install <type> <slug>` | 生成 Halo 安装载荷（skill/app/mcp） |
| `npm run serve` | 启动内网 HTTP 服务器提供注册表访问 |
| `npm run switch:deploy-target` | 切换注册表中所有 download_url 的目标平台 |