add-skill
Installation
SKILL.md
Add a User-Facing Skill
End-to-end workflow for creating a skill in skills/ that teaches AI agents how to use a cx CLI command. This skill is often invoked from add-command Step 6, but can also be used standalone when documenting an existing command.
contributing/adding-a-skill.md has the full reference guide and a copy-pasteable template. Read it alongside this workflow.
Step 0: Understand the Domain
Before writing anything, answer these questions:
- What cx command are you documenting? Identify the command and all its subcommands (e.g.,
cx alerts list,cx alerts get,cx alerts create). - What can the user do with it? List the key operations, flags, and output formats supported.
- Who is the audience? Skills are consumed by AI agents, not humans directly. Write instructions an agent can follow step-by-step to accomplish a user's goal.
- Is there dense reference material? Schemas, enum catalogs, field references, or language syntax exceeding ~100 lines belong in a separate
references/file.
Step 1: Read Existing Skills
Before writing any skill, read existing ones to internalize the project's patterns. Agents that study existing skills first produce consistent, high-quality results rather than inventing new formats.