Example Skill

VerifiedSafe

Example skill showcasing the full directory structure with scripts, references, assets, and examples. Use it as a reference when structuring new Codex skills.

Sby Skills Guide Bot
DocumentationBeginner
6/2/2026
Codex
#example#skill-structure#learning#template#codex

Recommended for

Automated summary

This skill is a demonstration example showing the full directory structure for Codex skills, including scripts, references, assets, and examples.

Strengths

  • Clear and well-organized structure
  • Easy to follow for beginners
  • Includes all necessary components
  • Serves as a reproducible template

Limitations

  • Performs no practical task
  • Purely demonstrative
  • Requires adapting references to your own project
When to use it

When you want to learn or teach the standard structure of a Codex skill.

When not to use it

When you need a ready-to-use skill for a specific task.

Security analysis

Safe
Quality score75/100

This is a harmless example skill describing directory structure with no executable code or dangerous instructions.

No concerns found

How this analysis is made

Examples

Create a new skill from template
Use the example-skill structure to create a new skill for generating project documentation. Include scripts, references, assets, and examples folders.
Learn skill structure
Show me how to structure a Codex skill using the example-skill as a reference. Explain each folder (scripts, references, assets, examples) and what they contain.
Validate skill structure
Run the validate.sh script from the example-skill to check if my skill directory follows the correct structure.

name: example-skill description: Example skill demonstrating the full skill directory structure with scripts, references, assets, and examples. Use when learning how to structure Codex skills.

Example Skill

This is a demonstration skill showing all possible subdirectories.

Quick Start

  1. Check references/patterns.md for detailed patterns
  2. Use assets/component-template.tsx as a starter
  3. Run scripts/validate.sh to check your code
  4. See examples/good-example.tsx for reference

Structure

  • scripts/ - Executable automation scripts
  • references/ - Detailed documentation
  • assets/ - Templates and resources
  • examples/ - Real code examples

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/example-skill-mm5t8a0g/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/example-skill-mm5t8a0g' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/example-skill-mm5t8a0g/download' --output '.skill-downloads/example-skill-mm5t8a0g/SKILL.md.part' && mv '.skill-downloads/example-skill-mm5t8a0g/SKILL.md.part' '.skill-downloads/example-skill-mm5t8a0g/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Codex
test -f '.skill-downloads/example-skill-mm5t8a0g/SKILL.md' && test -s '.skill-downloads/example-skill-mm5t8a0g/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/example-skill' && cp -R '.skill-downloads/example-skill-mm5t8a0g' '.agents/skills/example-skill'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/example-skill-mm5t8a0g'

openskills read 'example-skill-mm5t8a0g'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/example-skill-mm5t8a0g/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills