---
name: skill-creation-guide
description: "Guide for creating Agent Skills: structure, best practices, and SKILL.md format for Claude Code, Codex, Gemini CLI, and other AI agents."
title: skill-creation-guide
canonical_url: https://skilld.dev/gh/gmh5225/awesome-skills/skill-creation
last_updated: 2026-10-06T18:16:13.000Z
---

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install gmh5225/awesome-skills/skill-creation`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/skill-creation`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/gmh5225/awesome-skills/skill-creation) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/skill-creation`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/skill-creation --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/skill-creation --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Skill Creation Guide

## Scope

Use this skill when:

- Creating new Agent Skills
- Understanding SKILL.md format and conventions
- Learning best practices for skill authoring

## Skill Structure

```
skill-name/
├── SKILL.md          # Required: Instructions and metadata
├── scripts/          # Optional: Helper scripts
├── templates/        # Optional: Document templates
└── resources/        # Optional: Reference files
```

## SKILL.md Format

### Required Frontmatter

```yaml
---
name: my-skill-name
description: A clear description of what this skill does and when to use it.
---
```

### Body Structure

```markdown
# Skill Name

Detailed description of the skill's purpose.

## When to Use This Skill

- Use case 1
- Use case 2

## Instructions

[Detailed instructions for the agent]

## Examples

[Real-world examples]
```

## Best Practices

1. **Keep descriptions exhaustive**: The frontmatter description helps agents decide when to trigger the skill.
2. **Focus on execution**: The body should contain clear, actionable steps.
3. **Use progressive disclosure**: Put detailed references in `references/` folder.
4. **Include scripts for automation**: Use helper scripts for deterministic operations.
5. **Keep SKILL.md under 500 lines**: For optimal performance.
6. **Test across platforms**: Verify skills work with Claude Code, Codex, etc.

## Token Efficiency

Skills employ progressive disclosure architecture:

1. **Metadata loading** (~100 tokens): Agent scans available skills
2. **Full instructions** (<5k tokens): Load when skill is activated
3. **Bundled resources**: Only load as needed

## Platform-Specific Paths

| Platform | Project Path | Global Path |
|----------|--------------|-------------|
| Claude Code | `.claude/skills/` | `~/.claude/skills/` |
| Codex | `.codex/skills/` | `~/.codex/skills/` |
| Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
| Gemini CLI | `.gemini/skills/` | `~/.gemini/skills/` |
| GitHub Copilot | `.github/skills/` | `~/.copilot/skills/` |

## Quality Checklist

- [ ] Clear, actionable instructions
- [ ] Includes real-world examples
- [ ] Written for AI agents, not end users
- [ ] Documents prerequisites and dependencies
- [ ] Includes error handling guidance
- [ ] Tested on target platform(s)

## Full Resource List

For more detailed skill creation resources, complete link lists, or the latest information, use WebFetch to retrieve the full README.md:

```
https://raw.githubusercontent.com/gmh5225/awesome-skills/refs/heads/main/README.md
```

The README.md contains the complete categorized resource list with all links.
