jsdoc-standards

Devkit-AI

A curated collection of reusable skills, agents, and hooks — typescript-rules and jsdoc-standards — installable into Claude Code, Cursor, or OpenCode with a single command. Source files are runtime-neutral; the installer translates per-target so no runtime is privileged.

Install

npx devkit-ai

What the installer prompts

1. Editor — Claude Code, Cursor, or OpenCode.
2. Scope — project (committed to the repo), project-local (gitignored, just for you), or user-global (every project on this machine).
3. Plugins — multi-select; both are pre-checked. Empty selection cancels the run.
4. Conflicts — when a destination file already exists, the installer asks per file whether to overwrite, skip (default), or abort. On the first conflict the installer also asks once whether to apply your choice to every remaining conflict in this run, so you do not have to answer the same question repeatedly.

Ctrl-C at any prompt is a clean exit — no files are written until you confirm at the end of the prompt flow.

Where files land

Editor	project / project-local	user-global
Claude Code	<cwd>/.claude/	~/.claude/
Cursor	<cwd>/.cursor/	~/.cursor/
OpenCode	<cwd>/.opencode/	~/.config/opencode/

Inside each target the installer writes the standard subdirectories — skills/, commands/, agents/, and either hooks/hooks.json (Claude Code, OpenCode) or hooks.json at the root (Cursor). For project-local scope, the installer maintains a delimited block in <cwd>/.gitignore listing every file it wrote, so re-running the installer replaces the block in place and never duplicates entries:

# >>> Devkit-AI
.claude/skills/typescript-conventions/SKILL.md
.claude/commands/ts-review.md
...
# <<< Devkit-AI

Known limitations

• OpenCode hooks are skipped. OpenCode does not consume hooks.json; it expects a TypeScript plugin instead. Skills and commands are installed; real-time enforcement hooks won't fire under OpenCode until a TypeScript port ships.
• Cursor agents are skipped. Cursor does not currently expose a portable agent file format, so agents/*.md from typescript-rules and jsdoc-standards is not copied for Cursor targets. The skills and commands carry the relevant context.
• Cursor user-global scope ships best-effort. Only ~/.cursor/hooks.json and ~/.cursor/hooks/ are formally documented. Commands, rules, and skills at user scope follow the same shape but are not officially documented by Cursor.
• OpenCode agents and commands are translated at install time. The source files use Claude Code's frontmatter format (model: sonnet, ${CLAUDE_PLUGIN_ROOT}). For OpenCode targets, the installer drops the model line (so the agent inherits the user's opencode.json model — any provider), adds mode: subagent, removes Claude Code's allowed-tools: [Agent], and rewrites plugin-root paths to ... The body of every agent and command reads the same in both runtimes.

Flags

Flag	Effect
--dry-run	Print every file that would be written, without touching disk. Existing destinations are listed as would write (overwrites existing) — no prompts fire.
--help	Show usage and exit.
--version	Print the installer version and exit.

Releasing (maintainer note)

Releases are managed by release-please. On every push to main, release-please opens (or updates) a PR that bumps the version in package.json and .claude-plugin/marketplace.json and appends a changelog entry. Merging that PR creates a GitHub release with a vX.Y.Z tag, which triggers the publish job in .github/workflows/release-please.yml. That job runs npm pack --dry-run (sanity check) and then npm publish to the public npm registry, authenticated by an NPM_TOKEN secret (an npm access token with publish permissions, stored in the repository's GitHub secrets).

---

typescript-rules

A plugin that enforces TypeScript coding conventions with automatic validation, code review, and a dedicated reviewer agent.

Overview