skillit-cli-docs

Align Commander CLI command, flag, argument, and usage documentation with JSDoc annotations.

7|3|Updated Mar 21, 2026
One-click install
npx skills add https://github.com/pradeepmouli/skillit --skill skillit-cli-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skillit-cli-docs
Source: https://github.com/pradeepmouli/skillit/tree/main/packages/cli/skills/skillit-cli-docs
Command: npx skills add https://github.com/pradeepmouli/skillit --skill skillit-cli-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you turn incomplete or inconsistent command-line help into clear, discoverable documentation that users and agents can rely on.

Core Features & Use Cases

  • Command and subcommand descriptions: Improve .description() text so each CLI entry point explains intent, not just action verbs.
  • Flag and argument guidance: Document .option() flags, .argument() inputs, .usage() strings, examples, and environment-variable behavior.
  • Routing tag correlation: Place @useWhen, @avoidWhen, and @never guidance on TypeScript option interfaces so generated skills carry the right execution hints.
  • Use case: A developer has a large Commander-based CLI with sparse help output and wants the generated skill to explain every flag, positional value, and capability-based routing rule.

Quick Start

Ask the assistant to improve the CLI documentation conventions for a Commander-based tool and align each command, option, and routing tag with the generated skill.

Frequently Asked Questions about skillit-cli-docs

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

FAQPage Schema
How do I improve CLI help text for Commander.js commands?

Improve CLI help text by aligning Commander.js `.description()`, `.option()`, `.argument()`, and `.usage()` strings so each command entry point explains intent clearly. This ensures command-line documentation is consistent and discoverable for both users and generated skills.

What's the best way to document routing tags in TypeScript option interfaces?

Document routing tags by adding `@useWhen`, `@avoidWhen`, and `@never` JSDoc annotations directly onto `<PascalCommandName>Options` TypeScript interfaces. This correlates configuration surfaces with capability-driven execution hints for generated skills.

How do I document environment variables and positional arguments in a Node.js CLI?

Document environment variables and positional arguments by refining `.argument()` inputs and `.usage()` strings alongside `.option()` flags. This provides complete guidance for every input value and environment-variable behavior within the command-line tool.

Do I need JSDoc annotations to generate clear CLI documentation?

Yes, JSDoc annotations on `<PascalCommandName>Options` interfaces are required. They provide the structured metadata needed to correlate capability-driven routing tags and configuration surfaces with the generated skill's execution hints.

Can I fix sparse command-line help output for a large generated skill?

Yes, you can fix sparse help output by systematically improving `.description()` text and flag guidance across the entire Commander-based CLI tree. This transforms incomplete help into clear, discoverable documentation for every flag and positional value.

Why does my generated skill lack clear execution routing hints?

Generated skills lack routing hints when TypeScript option interfaces are missing `@useWhen`, `@avoidWhen`, and `@never` JSDoc annotations. Adding these tags correlates capabilities with the correct execution paths for the command-line tool.