skill-name

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Skill Name

Skill名称

Brief description of the skill and its purpose.
简要说明该Skill的功能及用途。

Prerequisites

前置条件

List any setup requirements:
  • Environment variables needed
  • API keys required
  • Dependencies (already listed in frontmatter above)
Example setup:
bash
export SKILL_API_KEY="your_api_key"
列出所有设置要求:
  • 所需的环境变量
  • 必要的API密钥
  • 依赖项(已在上方前置元数据中列出)
设置示例:
bash
export SKILL_API_KEY="your_api_key"

Quick Start

快速开始

How to use the skill quickly:
bash
cd <skill_directory>
python3 scripts/command.py --option value
如何快速使用该Skill:
bash
cd <skill_directory>
python3 scripts/command.py --option value

Usage Examples

使用示例

Example 1: Basic usage

示例1:基础用法

bash
python3 scripts/script.py "input"
Output:
Expected output here
bash
python3 scripts/script.py "input"
输出:
预期输出内容

Example 2: Advanced usage

示例2:高级用法

bash
python3 scripts/script.py "input" --flag --option value
bash
python3 scripts/script.py "input" --flag --option value

Commands

命令

All commands run from the skill directory.
所有命令均需在Skill目录下运行。

Command 1

命令1

bash
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value
bash
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value

Command 2

命令2

bash
python3 scripts/script2.py "param1" "param2"
bash
python3 scripts/script2.py "param1" "param2"

Scripts

脚本

  • script1.py
    - Description of what this script does
  • script2.py
    - Description of what this script does
  • script1.py
    - 该脚本的功能说明
  • script2.py
    - 该脚本的功能说明

API Info

API信息

  • Base URL: (if applicable)
  • Rate Limits: (if applicable)
  • Auth: (how authentication works)
  • Docs: Link to official documentation
  • 基础URL:(如适用)
  • 速率限制:(如适用)
  • 认证方式:(认证机制说明)
  • 文档:官方文档链接

Troubleshooting

故障排除

Issue 1

问题1

Symptom: Description of the problem
Solution:
  1. Step 1
  2. Step 2
症状:问题描述
解决方案
  1. 步骤1
  2. 步骤2

Issue 2

问题2

Symptom: Description of the problem
Solution:
  1. Step 1
  2. Step 2
症状:问题描述
解决方案
  1. 步骤1
  2. 步骤2

Examples

示例

See
examples/
directory for full workflow examples.
请查看
examples/
目录获取完整工作流示例。

References

参考资料

Notes

注意事项

  • Important note 1
  • Important note 2

  • 重要注意事项1
  • 重要注意事项2

Frontmatter Guide

前置元数据指南

The YAML frontmatter at the top of this file is required:
FieldTypeRequiredDescription
name
stringUnique identifier (kebab-case)
description
stringWhat the skill does and when to use it
triggers
arrayKeywords that activate this skill
dependencies
objectDependent skills (format:
skill-name: ">=X.Y.Z"
)
文件顶部的YAML前置元数据为必填项:
字段类型是否必填说明
name
字符串唯一标识符(短横线命名法)
description
字符串Skill的功能及适用场景说明
triggers
数组触发该Skill的关键词
dependencies
对象依赖的Skill(格式:
skill-name: ">=X.Y.Z"

Dependency Format

依赖格式

Use semantic versioning format:
  • "^1.0.0"
    - Compatible with 1.x versions
  • ">=1.0.0"
    - Version 1.0.0 or higher
  • "1.0.0"
    - Exact version only
  • ">=1.0.0,<2.0.0"
    - Range of versions
使用语义化版本格式:
  • "^1.0.0"
    - 兼容1.x版本
  • ">=1.0.0"
    - 1.0.0及以上版本
  • "1.0.0"
    - 仅精确版本
  • ">=1.0.0,<2.0.0"
    - 版本范围

Creating Your Skill

创建你的Skill

  1. Copy this template to
    skills/your-skill-name/
  2. Update the YAML frontmatter
  3. Write your SKILL.md documentation
  4. Add Python/shell scripts in
    scripts/
  5. Add usage examples in
    examples/
  6. Update
    skills.json
    with your skill entry
  7. Test with your agent before submitting PR
  1. 将此模板复制到
    skills/your-skill-name/
    目录
  2. 更新YAML前置元数据
  3. 编写你的SKILL.md文档
  4. scripts/
    目录中添加Python/Shell脚本
  5. examples/
    目录中添加使用示例
  6. skills.json
    中添加你的Skill条目
  7. 提交PR前,使用你的Agent进行测试