document-command

Generate and update CLI command documentation for the clio tool.

55|38|Updated Sep 26, 2018
One-click install
npx skills add https://github.com/Advance-Technologies-Foundation/clio --skill document-command
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-command
Source: https://github.com/Advance-Technologies-Foundation/clio/tree/main/.codex/skills/document-command
Command: npx skills add https://github.com/Advance-Technologies-Foundation/clio --skill document-command

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the need for accurate and up-to-date documentation for CLI commands within the clio tool, ensuring that users have reliable information at their fingertips.

Core Features & Use Cases

  • Command Documentation: Automatically generates and updates documentation for specified CLI commands.
  • Alias Resolution: Resolves command aliases to their canonical names for consistency.
  • Documentation Surfaces: Updates multiple documentation surfaces including clio/help/en/command-name.txt, clio/docs/commands/command-name.md, and clio/Commands.md.
  • Use Case: When a user requests documentation for a specific command, this Skill can quickly generate the necessary documentation from source code.

Quick Start

To document the 'clio register' command, use the skill with the command: 'document-command register'.

Frequently Asked Questions about document-command

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate CLI documentation from source code for the clio tool?

To generate CLI documentation from source code, use the document-command Skill to automatically parse the clio tool's source code and update specified command documentation files. It extracts command details directly from the source to ensure accuracy.

What is command alias resolution and how does it work for CLI documentation?

Command alias resolution maps command aliases to their canonical names, ensuring consistency across CLI documentation. This mechanism updates multiple documentation surfaces simultaneously, preventing discrepancies between alias usage and canonical command references.

Which documentation surfaces are updated when documenting clio commands?

Documenting clio commands updates three documentation surfaces: the CLI help text file, the Markdown command reference in the docs directory, and the main Commands.md file. This ensures both runtime help and static docs remain synchronized.

Do I need access to the clio source code to document CLI commands?

Yes, you need access to the clio source code and associated documentation files to document CLI commands. The Skill requires this access to accurately extract command logic and update the relevant documentation surfaces.

What is the best way to update documentation for the 'clio register' command?

The best way to update documentation for the 'clio register' command is to execute the document-command Skill with the 'register' argument. This automatically resolves aliases and updates all related help text and Markdown files.