Home / pradeepmouli / skillit · packages/cli/skills/skillit-cli-docs/SKILL.md · GitHub

skillit-cli-docs skillA

skillit-cli-docs is agent-read markdown (skill) from pradeepmouli/skillit: CLI documentation conventions for generated skills. Use when improving Commander descriptions, help text, positional argument docs, and config-surface correlation..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# CLI Documentation Conventions

Use this skill when documenting command-line programs for `@skillit/cli`.

## Focus Areas

- `.description()` text on commands and subcommands
- `.option()` and `--help` descriptions for every flag
- `.argument()` descriptions for positional inputs
- `.usage()` strings and example help text
- Environment-variable documentation and config-surface JSDoc correlation

## Routing Tags via Option Interfaces

For routing tags (`@useWhen`, `@avoidWhen`, `@never`), add them as JSDoc on
a `<PascalCommandName>Options` interface in a TypeScript source file.
The interface needs no properties — only the JSDoc block matters:

```typescript
/**
 * @useWhen - Server advertises callHierarchyProvider capability
 * @avoidWhen - Server doesn't support call hierarchy; lsproxy will error
 * @never - NEVER invoke without verifying server supports this capability. Fix: check --help output or use `lsproxy call` to probe the server first
 */
interface CallHierarchyOptions {}
```

`CliRefineSource` discovers these interfaces via the source glob (`**/*.ts`) and
correlates their tags onto the corresponding command in the generated skill.
…

Read the whole file at its exact version.

How to install

Latest version
mdr add pradeepmouli/skillit/skillit-cli-docs@v0.3.13
Exact content
mdr add pradeepmouli/skillit/skillit-cli-docs@sha256:228345a98dc2d75d

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_bgabp3bijp7v6d6c.svg)](https://markdownregistry.com/a/art_bgabp3bijp7v6d6c)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
v0.3.13 latest2026-07-02 3829cdf 1,957 BA view · diff
v0.3.132026-07-02 a1c6af7 1,960 BA view · diff
v0.3.132026-06-10 df9d69e 1,961 BA view · diff
v0.3.132026-06-04 b67a5b7 912 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (1957 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

pradeepmouli/skillit · 7 stars · license MIT · pushed 2026-09-22 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_bgabp3bijp7v6d6c
GET https://markdownregistry.com/api/v1/resolve?ref=pradeepmouli/skillit/skillit-cli-docs
GET https://markdownregistry.com/api/v1/blob/228345a98dc2d75db0c9e5512ee2a650ae3a77630b2d028bcbf8a7d84274803e

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from pradeepmouli/skillit

llms-full.txt llmstxt
pradeepmouli/skillit · llms-full.txt
git:20260702.6607d9d · audit A · 7 stars
llms.txt llmstxt
pradeepmouli/skillit · llms.txt
git:20260604.982a8d8 · audit A · 7 stars
skillit-bootstrap skill
pradeepmouli/skillit · packages/client/skills/skillit-bootstrap/SKILL.md · Bootstrap an AI-agent skill from a TypeScript codebase by running the deterministic skillit generate/audit loop and…
v0.1.0 · audit A · 7 stars
skillit-mcp-docs skill
pradeepmouli/skillit · packages/mcp/skills/skillit-mcp-docs/SKILL.md · MCP server documentation conventions for high-quality generated skills. Use when writing tool descriptions, `_meta`…
v0.1.0 · audit A · 7 stars
skillit-docs skill
pradeepmouli/skillit · packages/typedoc-plugin/skills/skillit-docs/SKILL.md · Documentation conventions for generating high-quality AI agent skills from TypeScript source. Use when preparing a…
v1.3.0 · audit A · 7 stars
skillit-docs skill
pradeepmouli/skillit · packages/typedoc/skills/skillit-docs/SKILL.md · Documentation conventions for generating high-quality AI agent skills from TypeScript source. Use when preparing a…
v1.3.0 · audit A · 7 stars
skillit-cli skill
pradeepmouli/skillit · skills/skillit-cli/SKILL.md · Extract CLI command structure from commander/yargs for AI agent skill generation Use when working with agent-skills…
git:20260702.6607d9d · audit A · 7 stars
skillit-core skill
pradeepmouli/skillit · skills/skillit-core/SKILL.md · Shared types, SKILL.md renderer, and token budgeting for skillit plugins
git:20260702.6607d9d · audit A · 7 stars
skillit-docs skill
pradeepmouli/skillit · skills/skillit-docs/SKILL.md · Generate AI agent skills from TypeScript documentation
git:20260604.42c5bcb · audit A · 7 stars
skillit-refine skill
pradeepmouli/skillit · skills/skillit-refine/SKILL.md · Autonomously improve an MCP skill via the skillit audit→draft→review loop (build or runtime mode) Also: skillit…
git:20260604.42c5bcb · audit A · 7 stars
skillit-typedoc skill
pradeepmouli/skillit · skills/skillit-typedoc/SKILL.md · TypeDoc plugin that generates AI agent skills (SKILL.md) from TypeScript API documentation Use when working with…
git:20260604.42c5bcb · audit A · 7 stars
skillit skill
pradeepmouli/skillit · skills/skillit/SKILL.md · Generate structured AI agent skills (SKILL.md) and llms.txt from your TypeScript API documentation
git:20260702.6607d9d · audit A · 7 stars

Every file in pradeepmouli/skillit

Browse by kind, by grade A, or by owner.