Skip to content

Appendix

This section provides technical reference materials for OpenSkills, including command-line API, file format specifications, and terminology definitions. When you need to look up specific command parameters, understand the structure of generated files, or clarify the meaning of a term, this is your quick reference.

This Section

DocumentDescription
CLI API ReferenceComplete documentation for all commands, options, and parameters, with usage examples
AGENTS.md Format SpecificationStructure of the AGENTS.md file generated by the sync command, including XML tags and skill list format
File StructureDescription of directories and files generated by OpenSkills, helping you understand what's in .openskills/
GlossaryExplanations of key terminology in OpenSkills and AI skill systems

The appendix is a reference section and doesn't need to be read from start to finish. Recommended usage:

  1. Encounter command issues → Check CLI API Reference
  2. Want to understand how AGENTS.md is generated → Read AGENTS.md Format Specification
  3. Unsure where files are located → Browse File Structure
  4. See unfamiliar terms → Look up Glossary

Beginner Recommendation

If you're new to OpenSkills, it's recommended to complete the Quick Start tutorial first, then come back to consult the appendix when you encounter issues.

Next Steps