How do I install the Jsdoc Gen skill?

Run npx skillmds@latest add kernel8901/jsdoc-gen in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Jsdoc Gen skill do?

Add JSDoc or TSDoc comments to your code. Use when documentation is missing. It is listed under Docs & Writing on SkillMD.

Is Jsdoc Gen safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Jsdoc Gen?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Jsdoc Gen free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Jsdoc Gen?

kernel8901 (@kernel8901) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Jsdoc Gen by kernel8901 — Agent Skill

Name: Jsdoc Gen
Author: kernel8901

File contents

JSDoc Generator

Your exported functions have no documentation. This tool adds JSDoc or TSDoc comments to all your exports without touching the actual code logic.

One command. Zero config. Just works.

Quick Start

npx ai-docs src/ --style jsdoc

What It Does

Adds JSDoc/TSDoc comments to exported functions and classes
Describes parameters, return values, and exceptions
Preserves all existing code and comments
Works on files, directories, or glob patterns

Usage Examples

# Preview docs for a directory
npx ai-docs src/ --style jsdoc

# TSDoc style
npx ai-docs src/ --style tsdoc

# Write changes to files
npx ai-docs src/ --style jsdoc --write

# Single file
npx ai-docs src/utils.ts --style jsdoc

# Glob patterns
npx ai-docs "src/**/*.ts" --style tsdoc

Best Practices

Preview first - run without --write to see what changes
Focus on exports - internal helpers don't need docs
Add examples - especially for complex functions
Review output - AI might miss nuances

When to Use This

Codebase has zero documentation
Onboarding requires reading every function
IDE hints are unhelpful without docs
Preparing for open source release

Part of the LXGIC Dev Toolkit

This is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.

Find more:

GitHub: https://github.com/LXGIC-Studios
Twitter: https://x.com/lxgicstudios
Substack: https://lxgicstudios.substack.com
Website: https://lxgic.dev

Requirements

No install needed. Just run with npx. Node.js 18+ recommended. Needs OPENAI_API_KEY environment variable.

npx ai-docs --help

How It Works

Reads your files, identifies exported functions, classes, and types, then generates appropriate documentation comments. The AI understands the function signatures and infers what each parameter does.

License

MIT. Free forever. Use it however you want.

---name: jsdoc-gendescription: Add JSDoc or TSDoc comments to your code. Use when documentation is missing.---# JSDoc GeneratorYour exported functions have no documentation. This tool adds JSDoc or TSDoc comments to all your exports without touching the actual code logic.**One command. Zero config. Just works.**## Quick Start```bashnpx ai-docs src/ --style jsdoc```## What It Does- Adds JSDoc/TSDoc comments to exported functions and classes- Describes parameters, return values, and exceptions- Preserves all existing code and comments- Works on files, directories, or glob patterns## Usage Examples```bash# Preview docs for a directorynpx ai-docs src/ --style jsdoc# TSDoc stylenpx ai-docs src/ --style tsdoc# Write changes to filesnpx ai-docs src/ --style jsdoc --write# Single filenpx ai-docs src/utils.ts --style jsdoc# Glob patternsnpx ai-docs "src/**/*.ts" --style tsdoc```## Best Practices- **Preview first** - run without --write to see what changes- **Focus on exports** - internal helpers don't need docs- **Add examples** - especially for complex functions- **Review output** - AI might miss nuances## When to Use This- Codebase has zero documentation- Onboarding requires reading every function- IDE hints are unhelpful without docs- Preparing for open source release## Part of the LXGIC Dev ToolkitThis is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.**Find more:**- GitHub: https://github.com/LXGIC-Studios- Twitter: https://x.com/lxgicstudios- Substack: https://lxgicstudios.substack.com- Website: https://lxgic.dev## RequirementsNo install needed. Just run with npx. Node.js 18+ recommended. Needs OPENAI_API_KEY environment variable.```bashnpx ai-docs --help```## How It WorksReads your files, identifies exported functions, classes, and types, then generates appropriate documentation comments. The AI understands the function signatures and infers what each parameter does.## LicenseMIT. Free forever. Use it however you want.

Frequently asked questions

Jsdoc Gen