mcpField
C
commandkit

commandkit

github.com/neplexlabs开发16446 次安装3 天前更新
代码仓库

关于 commandkit

commandkit 是帮助开发者按约定构建和维护 CommandKit 项目的技能，涵盖配置、命令与事件组织、中间件及 JSX 交互组件。它还提供项目结构检查工具和分主题参考资料。

主要功能

  1. 01指导项目目录与文件约定
  2. 02说明配置及插件注册方式
  3. 03覆盖命令、事件和中间件实现
  4. 04提供 JSX 交互组件参考
  5. 05检查必需的项目结构

适用场景

  1. 01验证 CommandKit 项目基础结构
  2. 02按约定添加命令或事件处理器
  3. 03配置插件及运行时初始化
  4. 04迁移到约定式项目布局

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/commandkit确认已加载。

包含的文件

除 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

详细介绍

CommandKit Core

激活指南

在以下框架级架构和实现工作中使用此技能：

  • 命令和事件文件的放置位置
  • commandkit.config 策略和插件接线
  • 中间件生命周期行为
  • JSX 交互组件和处理程序
  • 项目结构验证，以及迁移到基于约定的布局

必需的文件系统规范

  • 项目根目录下的 commandkit.config.ts（或 .js）
  • 命令位于 src/app/commands/**
  • 事件位于 src/app/events/**
  • 启用相应插件时可选的插件专用目录（src/app/locales、 src/app/tasks、src/workflows）

配置规范

  • 使用 commandkit/config 中的 defineConfig。
  • 在 plugins: [] 中显式注册插件。
  • 对仅限运行时的设置（例如任务/驱动程序初始化）使用 noBuildOnly() 等启动守卫。
  • 明确设置依赖环境的插件开关。

执行工作流

  1. 首先验证结构和基础配置。
  2. 将命令/事件文件放在约定的路径中。
  3. 使用带类型的上下文和元数据实现命令逻辑。
  4. 仅针对横切关注点添加中间件。
  5. 使用本地开发命令验证运行时行为。

防护准则

  • 不要臆造 CommandKit API。
  • 避免使用绕过约定发现机制、需要大量注册的模式。
  • 保持处理程序简洁，并将可复用逻辑移至辅助函数/服务中。

参考索引

名称描述
references/00-filesystem-structure.md标准项目布局、必需路径和结构验证指南。
references/01-config-and-structure.md详细的配置模式、插件接线策略，以及按任务划分的配置示例。
references/02-chat-input-command.md带元数据和响应处理的基础斜杠命令模式。
references/03-event-handler.md事件监听器约定和生命周期最佳实践。
references/04-jsx-components.md基于真实项目用法的有效 JSX 组件模式（包括交互式处理程序）。
references/05-middlewares.md全局、目录级和命令专用中间件模式及其顺序。
references/06-config-recipes.md面向任务的常见机器人配置示例（仅核心、AI、缓存、任务、工作流）。
references/07-sharding-your-bot.md分片管理器设置、入口点行为，以及与扩展规模相关的分片规划。
references/08-file-naming-conventions.mdCommandKit 自动发现的特殊文件名/目录，以及它们对运行时的影响。
references/09-manual-setup.md配置、应用入口点、命令、事件以及运行/构建/启动的完整手动设置流程。
references/10-cli-api.md高级 CLI 编程式 API 用法模式和限制。

工具索引

名称描述
tools/check-structure.mjs检查当前项目中是否存在 CommandKit 核心所需路径。

评论

支持 Markdown