skill-repo
npx machina-cli add skill netresearch/skill-repo-skill/skill-repo --openclawSkill Repository Structure Guide
Standards for Netresearch skill repository layout and distribution.
When to Use
- Creating a new skill repository
- Standardizing an existing skill repo
- Setting up release workflows
Repository Structure
{skill-name}/
├── SKILL.md # AI instructions (required)
├── README.md # Human documentation (required)
├── LICENSE # MIT (required)
├── composer.json # PHP distribution
├── references/ # Extended docs
├── scripts/ # Automation
└── .github/workflows/release.yml
SKILL.md Requirements
---
name: skill-name # lowercase, hyphens, max 64 chars
description: "Use when <trigger conditions>"
---
- Under 500 lines, use references/ for extended content
Installation Methods
- Marketplace:
/plugin marketplace add netresearch/claude-code-marketplace - Release: Download and extract to
~/.claude/skills/{name}/ - Composer:
composer require netresearch/{repo-name}
Composer Package
Composer name must match GitHub repo name exactly.
{
"name": "netresearch/{repo-name}",
"type": "ai-agent-skill",
"require": {"netresearch/composer-agent-skill-plugin": "*"},
"extra": {"ai-agent-skill": "SKILL.md"}
}
Validation
scripts/validate-skill.sh
References
references/installation-methods.mdreferences/composer-setup.mdtemplates/README.md.template
Contributing: https://github.com/netresearch/skill-repo-skill
Source
git clone https://github.com/netresearch/skill-repo-skill/blob/main/skills/skill-repo/SKILL.mdView on GitHub Overview
This guide defines a canonical Netresearch skill repository layout and distribution rules. It covers required files (SKILL.md, README.md, LICENSE, composer.json), references for extended content, and how to prepare skills for composer-based distribution and automated releases.
How This Skill Works
It enforces a canonical folder structure (skill-name/ with SKILL.md, README.md, LICENSE, composer.json, references/, scripts/, and .github/workflows/release.yml), validates content via scripts/validate-skill.sh, and provides clear paths for Marketplace, Release, and Composer installation. The SKILL.md template and composer.json example ensure consistent metadata and packaging across skills.
When to Use It
- Creating a new skill repository
- Standardizing an existing skill repository
- Setting up release workflows for skills
- Packaging a skill for Composer distribution (netresearch/{repo-name})
- Validating and enforcing SKILL.md and repository structure before release
Quick Start
- Step 1: Create the repository folder {skill-name} and add SKILL.md, README.md, LICENSE, composer.json, references/, scripts/, and .github/workflows/release.yml
- Step 2: Populate SKILL.md with the YAML header (name: skill-name, description: "Use when <trigger conditions>") and a concise description
- Step 3: Run the validator to ensure conformance: scripts/validate-skill.sh, then configure marketplace, release, or composer installation as needed
Best Practices
- Follow the {skill-name}/ layout: SKILL.md, README.md, LICENSE, composer.json, references/, scripts/, and .github/workflows/release.yml
- Keep SKILL.md under 500 lines and place extended content in references/
- Ensure the composer.json name matches the GitHub repo name exactly and uses type "ai-agent-skill"
- Use the provided validation script: scripts/validate-skill.sh
- Document installation methods (Marketplace, Release, Composer) and align with the reference templates
Example Use Cases
- netresearch/ai-code-summarizer-skill following the canonical layout with SKILL.md, references/, and a release workflow
- netresearch/chat-formatter-skill standardized to use the template SKILL.md and composer packaging
- netresearch/data-cleaner-skill structured for Composer distribution with matching repo name
- netresearch/code-review-skill with a release.yml workflow for automated releases
- netresearch/sample-skill-for-testing demonstrating all required files and validation
