mcpField
C
commandkit

commandkit

github.com/neplexlabsDevelopment16446 installsUpdated 2d ago
Repository

About commandkit

commandkit is a skill for developers building and maintaining CommandKit projects using its conventions. It covers configuration, command and event organization, middleware, JSX interactions, and structure checks.

Key features

  1. 01Guide project paths and file conventions
  2. 02Explain config and plugin registration
  3. 03Cover commands, events, and middleware
  4. 04Reference JSX interaction components
  5. 05Check required project structure

Use cases

  1. 01Validate a CommandKit project's baseline structure
  2. 02Add commands or event handlers conventionally
  3. 03Configure plugins and runtime initialization
  4. 04Migrate to a convention-based project layout

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/neplexlabs/commandkit --skill commandkit

After installing, type/commandkitin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
references/
00-filesystem-structure.md
01-config-and-structure.md
02-chat-input-command.md
03-event-handler.md
04-jsx-components.md
05-middlewares.md
06-config-recipes.md
07-sharding-your-bot.md
08-file-naming-conventions.md
09-manual-setup.md
10-cli-api.md
tools/
check-structure.mjs

Details

From the project README

CommandKit Core

Activation guidance

Use this skill for framework-level architecture and implementation:

  • command and event file placement
  • commandkit.config strategy and plugin wiring
  • middleware lifecycle behavior
  • JSX interaction components and handlers
  • project structure validation and migration to convention-based layouts

Required filesystem expectations

  • commandkit.config.ts (or .js) at project root
  • src/app/commands/** for commands
  • src/app/events/** for events
  • optional plugin-specific folders (src/app/locales, src/app/tasks, src/workflows) when those plugins are enabled

Configuration expectations

  • Use defineConfig from commandkit/config.
  • Register plugins explicitly in plugins: [].
  • Use startup guards like noBuildOnly() for runtime-only setup (for example task/driver init).
  • Keep environment-sensitive plugin toggles explicit.

Execution workflow

  1. Validate structure and baseline config first.
  2. Place command/event files in convention paths.
  3. Implement command logic with typed context and metadata.
  4. Add middleware only for cross-cutting concerns.
  5. Verify runtime behavior with local dev command.

Guardrails

  • Do not invent CommandKit APIs.
  • Avoid registration-heavy patterns that bypass convention discovery.
  • Keep handlers small and move reusable logic to helpers/services.

Reference index

NameDescription
references/00-filesystem-structure.mdCanonical project layout, required paths, and structure validation guidance.
references/01-config-and-structure.mdDetailed config patterns, plugin wiring strategies, and config recipes by task.
references/02-chat-input-command.mdBaseline slash command pattern with metadata and response handling.
references/03-event-handler.mdEvent listener conventions and lifecycle best practices.
references/04-jsx-components.mdValid JSX component patterns (including interactive handlers) based on real project usage.
references/05-middlewares.mdGlobal, directory, and command-specific middleware patterns and ordering.
references/06-config-recipes.mdTask-oriented config recipes for common bot setups (core only, AI, cache, tasks, workflow).
references/07-sharding-your-bot.mdSharding manager setup, entrypoint behavior, and scale-related shard planning.
references/08-file-naming-conventions.mdSpecial filenames/directories CommandKit auto-discovers and how they affect runtime.
references/09-manual-setup.mdFull manual setup flow for config, app entrypoint, commands, events, and run/build/start.
references/10-cli-api.mdAdvanced programmatic CLI API usage patterns and constraints.

Tool index

NameDescription
tools/check-structure.mjsChecks whether required core CommandKit paths exist in the current project.

Comments

Markdown supported