Back to Cherry Studio

Skills Management

.agents/skills/README.md

1.9.42.0 KB
Original Source

Skills Management

This directory is the single source of truth for repository skills.

Add a New Skill

  1. Create a new folder under .agents/skills/<skill-name>/.
  2. Add a SKILL.md file with:
    • name and description in YAML frontmatter
    • concise workflow instructions in the body
  3. (Optional) Add agents/openai.yaml if Codex UI metadata is needed.
  4. If this skill should be shared in the repository, append <skill-name> to .agents/skills/public-skills.txt.

Naming Rules

  • Use lowercase letters, digits, and hyphens only.
  • Prefer short, action-oriented names (for example: gh-create-pr).

Claude Compatibility

For each new public skill, run:

bash
pnpm skills:sync

skills:sync will create/update .claude/skills/<skill-name> as a symlink pointing to ../../.agents/skills/<skill-name>.

Windows Compatibility

This project uses symlinks to synchronize files such as AGENTS.md and skills. Windows developers must enable symlink support:

  1. Enable Developer Mode (Settings → Update & Security → For developers), or
  2. Grant SeCreateSymbolicLinkPrivilege via Local Security Policy (secpol.msc).
  3. Configure Git to create symlinks:
    bash
    git config --global core.symlinks true
    
  4. Re-clone the repository (or run pnpm skills:sync) after enabling symlink support.

White-list Tracking Rules

The public white-list is defined in .agents/skills/public-skills.txt.

  • Skills listed there are synced to both .agents/skills/.gitignore and .claude/skills/.gitignore.
  • Private/local-only skills should stay out of public-skills.txt.
  • Use one skill name per line. Comment lines must start with # and cannot be appended inline.

After updating public-skills.txt, run:

bash
pnpm skills:sync

Then validate:

bash
pnpm skills:check

The sync/check scripts manage and verify:

  • .agents/skills/.gitignore
  • .claude/skills/.gitignore
  • .claude/skills/<skill-name> is a valid symlink to .agents/skills/<skill-name>