feat: adapt OpenPencil skill for MiaoGai
- Publish skills/miaogai with miaogai / miaogai-mcp binaries - Point install at the private Gitea skills repo - Document 0.14.x CLI extras (documents, import, libraries, overlaps) Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
40
README.md
40
README.md
@@ -1,32 +1,46 @@
|
||||
# OpenPencil Skills
|
||||
# MiaoGai Skills
|
||||
|
||||
Agent skills for [OpenPencil](https://github.com/open-pencil/open-pencil) — the open-source design editor.
|
||||
Agent skills for [MiaoGai](https://www.miaogai.com) (秒改Ai) — inspect designs, export assets, analyze tokens, and modify `.fig` files from coding agents.
|
||||
|
||||
This repository is a MiaoGai fork of [open-pencil/skills](https://github.com/open-pencil/skills). The `skills.sh` layout is unchanged: each skill lives at `skills/<name>/SKILL.md`.
|
||||
|
||||
## Install
|
||||
|
||||
Private Gitea (SSH):
|
||||
|
||||
```bash
|
||||
npx skills add open-pencil/skills@open-pencil
|
||||
npx skills add ssh://git@git.zhangjianliang.com:2222/miaogai/skills.git --skill miaogai
|
||||
```
|
||||
|
||||
For OpenPencil tooling used by the skill:
|
||||
The installer copies `skills/miaogai/SKILL.md` into the agent skill directory (for example `.cursor/skills/miaogai/` or `~/.cursor/skills/miaogai/`). It does **not** install the CLI or MCP server.
|
||||
|
||||
Then install the tools the skill tells the agent to run:
|
||||
|
||||
```bash
|
||||
bun add -g @open-pencil/cli @open-pencil/mcp
|
||||
```
|
||||
|
||||
Binaries after install: `miaogai`, `miaogai-mcp`, `miaogai-mcp-http`.
|
||||
|
||||
## Available Skills
|
||||
|
||||
| Skill | Description |
|
||||
|-------|-------------|
|
||||
| `open-pencil` | CLI + MCP tools for .fig files and the running editor |
|
||||
| `miaogai` | CLI + MCP tools for `.fig` files and the running MiaoGai editor |
|
||||
|
||||
## Syncing from upstream
|
||||
|
||||
```bash
|
||||
git remote add upstream https://github.com/open-pencil/skills.git # once
|
||||
git fetch upstream
|
||||
git merge upstream/master # resolve SKILL.md for miaogai binaries and product names
|
||||
```
|
||||
|
||||
Keep `skills/miaogai/` as the published skill folder. Do not restore `skills/open-pencil/` unless you also want the upstream skill name.
|
||||
|
||||
## Links
|
||||
|
||||
- [OpenPencil](https://github.com/open-pencil/open-pencil) — editor & core
|
||||
- [Documentation](https://openpencil.dev)
|
||||
- [MCP Server](https://www.npmjs.com/package/@open-pencil/mcp) — `openpencil-mcp` / `openpencil-mcp-http`
|
||||
- [CLI](https://www.npmjs.com/package/@open-pencil/cli) — `openpencil`
|
||||
|
||||
---
|
||||
|
||||
Maintained as part of [OpenPencil](https://github.com/open-pencil) for the [OpenPencil editor](https://github.com/open-pencil/open-pencil).
|
||||
- [MiaoGai](https://www.miaogai.com) — product site
|
||||
- [Documentation](https://www.miaogai.com/programmable/mcp-server)
|
||||
- [MCP](https://www.npmjs.com/package/@open-pencil/mcp) — `miaogai-mcp` / `miaogai-mcp-http`
|
||||
- [CLI](https://www.npmjs.com/package/@open-pencil/cli) — `miaogai`
|
||||
|
||||
Reference in New Issue
Block a user