Forráskód Böngészése

docs: add 5-minute fskill quickstart

wandl-6A72h 6 hónapja
szülő
commit
31ba16077c
2 módosított fájl, 150 hozzáadás és 0 törlés
  1. 75 0
      README.md
  2. 75 0
      README_EN.md

+ 75 - 0
README.md

@@ -20,6 +20,81 @@
 
 
 > **说明:** 当前仓库内共有 **42 个技能组目录**、**421 个 `SKILL.md` 文件**;其中 Marketplace 当前发布 **40 个插件**、共 **410 条技能路径**。未进入 Marketplace 的仓库内技能组为 `threejs-skills` 与 `vscode-skills`。
 > **说明:** 当前仓库内共有 **42 个技能组目录**、**421 个 `SKILL.md` 文件**;其中 Marketplace 当前发布 **40 个插件**、共 **410 条技能路径**。未进入 Marketplace 的仓库内技能组为 `threejs-skills` 与 `vscode-skills`。
 
 
+## ⚡ 5 分钟安装与转换示例
+
+如果你只想尽快把仓库里的 skills 安装到本地项目或其它平台,按下面的最短路径执行即可。
+
+### 1. 安装 `fskill`
+
+```bash
+git clone https://github.com/partme-ai/full-stack-skills.git
+cd full-stack-skills
+npm install -g ./adapters
+fskill --version
+```
+
+### 2. 查看平台与审计仓库
+
+```bash
+fskill platforms
+fskill audit
+```
+
+### 3. 默认安装到当前项目 `.agents/skills/`
+
+```bash
+mkdir demo-project && cd demo-project
+fskill install --skills-dir ../full-stack-skills/skills
+```
+
+这条命令会把 skills 安装到当前项目的 `.agents/skills/`,适用于 `amp`、`kimi-cli`、`replit`、`universal`、`cursor`、`codex`、`cline`、`warp`、`opencode` 等标准路径兼容平台。
+
+### 4. 安装到 Cursor
+
+```bash
+fskill install --platform cursor --scope project --skills-dir ../full-stack-skills/skills
+```
+
+- **项目级路径**:`.agents/skills/`
+- **全局路径**:`~/.cursor/skills/`
+
+如需安装到 Cursor 全局目录:
+
+```bash
+fskill install --platform cursor --scope global --skills-dir ./skills
+```
+
+### 5. 导出全部平台目录
+
+```bash
+cd full-stack-skills
+fskill convert --platform all --output ./adapters-output
+```
+
+导出结果会按平台写入:
+
+```text
+adapters-output/<platform>/<project-path>/<skill-name>/
+```
+
+### 6. 常用场景
+
+```bash
+# 安装到 Claude Code 项目目录
+fskill install --platform claude-code --scope project --skills-dir ./skills
+
+# 安装到 Antigravity 全局目录
+fskill install --platform antigravity --scope global --skills-dir ./skills
+
+# 只安装指定 skill
+fskill install --platform cursor --scope global --skills-dir ./skills --skill react --skill vue3
+```
+
+更多适配器细节请直接查看:
+
+- [平台适配器工具](adapters/README.md)
+- [跨平台使用指南](PLATFORM_GUIDE.md)
+
 ## 什么是 Skills?
 ## 什么是 Skills?
 
 
 Skills 是由说明、脚本和资源组成的文件夹,Claude 会按需动态加载它们,以提升在特定任务上的表现。Skills 用于以可复用的方式教会 Claude 完成具体工作,例如:按团队规范创建文档、执行特定技术流程、沉淀设计系统知识,或自动化重复性工程任务。
 Skills 是由说明、脚本和资源组成的文件夹,Claude 会按需动态加载它们,以提升在特定任务上的表现。Skills 用于以可复用的方式教会 Claude 完成具体工作,例如:按团队规范创建文档、执行特定技术流程、沉淀设计系统知识,或自动化重复性工程任务。

+ 75 - 0
README_EN.md

@@ -10,6 +10,81 @@ A grouped Agent Skills repository for Claude Code, Claude.ai, and compatible Age
 
 
 > **Note:** This repository is maintained as a grouped skills catalog. The current documentation follows the actual `skills/` directory layout and `.claude-plugin/marketplace.json` rather than older category-based packaging.
 > **Note:** This repository is maintained as a grouped skills catalog. The current documentation follows the actual `skills/` directory layout and `.claude-plugin/marketplace.json` rather than older category-based packaging.
 
 
+## ⚡ 5-Minute Install and Conversion
+
+If you want the shortest path to install or convert skills for local projects and other platforms, use the workflow below.
+
+### 1. Install `fskill`
+
+```bash
+git clone https://github.com/partme-ai/full-stack-skills.git
+cd full-stack-skills
+npm install -g ./adapters
+fskill --version
+```
+
+### 2. List platforms and audit the repository
+
+```bash
+fskill platforms
+fskill audit
+```
+
+### 3. Install to the default `.agents/skills/` path
+
+```bash
+mkdir demo-project && cd demo-project
+fskill install --skills-dir ../full-stack-skills/skills
+```
+
+This installs skills into the current project's `.agents/skills/`, which works for standard-path platforms such as `amp`, `kimi-cli`, `replit`, `universal`, `cursor`, `codex`, `cline`, `warp`, and `opencode`.
+
+### 4. Install to Cursor
+
+```bash
+fskill install --platform cursor --scope project --skills-dir ../full-stack-skills/skills
+```
+
+- **Project path**: `.agents/skills/`
+- **Global path**: `~/.cursor/skills/`
+
+To install into Cursor’s global directory:
+
+```bash
+fskill install --platform cursor --scope global --skills-dir ./skills
+```
+
+### 5. Export all platform layouts
+
+```bash
+cd full-stack-skills
+fskill convert --platform all --output ./adapters-output
+```
+
+Outputs are written as:
+
+```text
+adapters-output/<platform>/<project-path>/<skill-name>/
+```
+
+### 6. Common scenarios
+
+```bash
+# Install into a Claude Code project
+fskill install --platform claude-code --scope project --skills-dir ./skills
+
+# Install into Antigravity global directory
+fskill install --platform antigravity --scope global --skills-dir ./skills
+
+# Install only selected skills
+fskill install --platform cursor --scope global --skills-dir ./skills --skill react --skill vue3
+```
+
+For detailed adapter behavior, use:
+
+- [Adapter CLI reference](adapters/README.md)
+- [Cross-platform usage guide](PLATFORM_GUIDE.md)
+
 ## What are Skills?
 ## What are Skills?
 
 
 Skills are folders of instructions, scripts, and resources that Claude loads dynamically to improve performance on specialized tasks. Skills teach Claude how to complete repeatable tasks in a reusable way, whether that means documentation workflows, frontend implementation, system design, testing, or delivery automation.
 Skills are folders of instructions, scripts, and resources that Claude loads dynamically to improve performance on specialized tasks. Skills teach Claude how to complete repeatable tasks in a reusable way, whether that means documentation workflows, frontend implementation, system design, testing, or delivery automation.