chore: 初始化仓库

This commit is contained in:
Lydanne
2026-02-15 22:02:21 +08:00
commit 08d011d63f
381 changed files with 87202 additions and 0 deletions

View File

@@ -0,0 +1,90 @@
# create — 创建模板
基于模板创建新的 Extension 项目。支持本地模板和远程 Git 仓库模板。
## 基本用法
```bash
# 创建命令型 Extension
spaceflow create command my-cmd
# 创建技能型 Extension
spaceflow create skills my-skill
# 查看可用模板
spaceflow create --list
# 指定输出目录
spaceflow create command my-cmd -d ./plugins/my-cmd
# 使用远程模板仓库
spaceflow create --from https://github.com/user/templates command my-cmd
# 使用远程模板仓库的指定分支/标签
spaceflow create --from git@github.com:org/tpl.git --ref v1.0 api my-api
```
## 模板类型
模板动态读取自项目的 `templates/` 目录。内置模板包括:
| 模板 | 说明 |
|------|------|
| `command` | 命令型 Extension提供 CLI 命令 |
| `skills` | 技能型 Extension提供编辑器 AI 技能文件 |
## 远程模板
使用 `--from` 指定远程 Git 仓库作为模板来源:
```bash
# GitHub 仓库
spaceflow create --from https://github.com/user/templates command my-cmd
# Gitea 仓库
spaceflow create --from https://git.example.com/org/templates command my-cmd
# SSH + 指定 ref
spaceflow create --from git@github.com:org/tpl.git --ref v1.0 api my-api
```
远程模板会被下载到本地缓存,后续使用时优先使用缓存。
## 生成的文件结构
`command` 模板为例:
```text
my-cmd/
├── src/
│ ├── my-cmd.command.ts # 命令定义
│ ├── my-cmd.service.ts # 业务逻辑
│ ├── my-cmd.module.ts # NestJS 模块
│ └── index.ts # Extension 入口
├── package.json
├── tsconfig.json
└── README.md
```
## 命令行选项
| 选项 | 简写 | 说明 |
|------|------|------|
| `--directory <dir>` | `-d` | 指定输出目录 |
| `--list` | `-l` | 列出可用模板 |
| `--from <repo>` | `-f` | 远程模板仓库 URL |
| `--ref <ref>` | `-r` | 远程仓库的分支/标签/commit |
| `--verbose` | `-v` | 详细日志 |
## 示例
```bash
# 查看所有可用模板
spaceflow create --list
# 查看远程仓库的可用模板
spaceflow create --from https://github.com/org/templates --list
# 创建并指定目录
spaceflow create command my-review -d ./commands/my-review
```