Add GSP init and AI usage tooling
This commit is contained in:
93
README.md
93
README.md
@@ -8,7 +8,7 @@ GSP 是一个通用游戏规格协议与配套工具链,用于在人类、AI
|
||||
|
||||
```text
|
||||
GSP/
|
||||
language/ GSP 语言定义与 schema
|
||||
specs/ GSP 版本化协议规范与 schema
|
||||
toolkit/ GSP Toolkit Go CLI 源码
|
||||
examples/ 示例 GSP 工程
|
||||
```
|
||||
@@ -68,9 +68,12 @@ bin/gsp.exe
|
||||
|
||||
| 文档 | 作用 |
|
||||
|---|---|
|
||||
| `language/README.md` | GSP 语言说明。 |
|
||||
| `language/gsp.schema.json` | GSP 核心字段 schema。 |
|
||||
| `language/gsp.manifest.schema.json` | GSP 工程 manifest schema。 |
|
||||
| `specs/README.md` | GSP 规范版本入口。 |
|
||||
| `specs/versions/0.1/README.md` | GSP 0.1 语言说明。 |
|
||||
| `specs/versions/0.1/gsp.schema.json` | GSP 0.1 核心字段 schema。 |
|
||||
| `specs/versions/0.1/gsp.manifest.schema.json` | GSP 0.1 工程 manifest schema。 |
|
||||
| `specs/versions/0.1/commands.md` | GSP 0.1 命令规范。 |
|
||||
| `specs/versions/0.1/ai-usage.md` | GSP 0.1 AI 使用规则。 |
|
||||
| `toolkit/README.md` | GSP Toolkit 命令与实现说明。 |
|
||||
|
||||
## GSP 工程结构
|
||||
@@ -85,3 +88,85 @@ project/
|
||||
```
|
||||
|
||||
Toolkit 默认从工程根目录的 `design/` 目录扫描 `.gsp` 文件。`gsp.manifest` 可声明语言版本、Toolkit 版本、入口 GSP、扫描范围、阶段规则和 type 列表。
|
||||
|
||||
## AI 使用入口
|
||||
|
||||
给当前 GSP 工程生成 AI 友好入口:
|
||||
|
||||
```bash
|
||||
gsp ai-init
|
||||
```
|
||||
|
||||
默认生成:
|
||||
|
||||
```text
|
||||
README.md
|
||||
AI_USAGE.md
|
||||
```
|
||||
|
||||
可选生成代理说明或 skill 入口:
|
||||
|
||||
```bash
|
||||
gsp ai-init --agents
|
||||
gsp ai-init --skill generic
|
||||
gsp ai-init --skill codex
|
||||
gsp ai-init --all
|
||||
```
|
||||
|
||||
## 安装为命令
|
||||
|
||||
Windows:
|
||||
|
||||
```powershell
|
||||
powershell -ExecutionPolicy Bypass -File .\toolkit\scripts\install.ps1
|
||||
gsp version
|
||||
```
|
||||
|
||||
macOS:
|
||||
|
||||
```bash
|
||||
sh ./toolkit/scripts/install.sh
|
||||
gsp version
|
||||
```
|
||||
|
||||
安装后可以在任意目录使用:
|
||||
|
||||
```bash
|
||||
gsp init
|
||||
gsp ai-init
|
||||
gsp version
|
||||
gsp validate
|
||||
gsp index
|
||||
gsp flatten <id>
|
||||
gsp graph <id>
|
||||
gsp stage-check --stage implement
|
||||
```
|
||||
|
||||
## 初始化 GSP 工程
|
||||
|
||||
在当前目录初始化:
|
||||
|
||||
```bash
|
||||
gsp init
|
||||
```
|
||||
|
||||
在指定目录初始化:
|
||||
|
||||
```bash
|
||||
gsp init path/to/project --name project-name --entry project.entry
|
||||
```
|
||||
|
||||
初始化结果:
|
||||
|
||||
```text
|
||||
project/
|
||||
gsp.manifest
|
||||
design/
|
||||
project.entry.gsp
|
||||
```
|
||||
|
||||
已有 `gsp.manifest` 或入口 `.gsp` 时,`gsp init` 默认不会覆盖。需要重建初始化文件时使用:
|
||||
|
||||
```bash
|
||||
gsp init path/to/project --force
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user