Scan to join WeChat grouparticle
README
🚀 MCP 巴 CLI 管理器
MCP 巴 CLI 管理器是一款用于管理 MCP 服务器的命令行界面工具，能帮助用户简单高效地完成服务器的安装与管理，且支持跨平台使用。
🚀 快速开始
MCP 巴 CLI 管理器可让你轻松管理 MCP 服务器。以下是基本的使用步骤：
- 安装该工具。
- 安装、卸载或列出 MCP 服务器。
✨ 主要特性
- 🔄 简单安装和管理 MCP 服务器，让服务器管理工作变得轻松。
- 📱 跨平台支持，无论你使用何种操作系统，都能正常使用。
📦 安装指南
使用以下命令全局安装 MCP 巴 CLI 管理器：
npm install -g mcpbar
💻 使用示例
基础用法
# 🔍 安装一个服务器
mcpbar install playwright # 安装 Playwright 服务器
# 🗑️ 卸载一个服务器
mcpbar remove playwright # 卸载 Playwright 服务器
# 📋 列出已安装的服务器
mcpbar list # 显示设备上已安装的 MCP 服务器
📚 详细文档
运行命令
- 在开发模式下，使用
pnpm start [command name]来运行任何命令。此方法利用了ts-node，提供无缝的开发体验。 - 在生产环境中，直接从构建后的项目执行 CLI 应用程序，格式为
mcpbar [command name]。
所有命令均位于 src/commands/ 文件夹中。这种组织方式便于查找和修改现有命令，或添加新的命令。
代码规范与工具
- 代码风格：使用 Prettier 进行代码格式化，确保代码风格统一。
- 代码检查：使用 ESLint 进行代码质量检测，及时发现并解决潜在问题。
- 类型定义：使用 TypeScript 提供类型安全，增强代码的可靠性。
提交规范
项目采用 conventional commit 规范进行版本控制。提交信息需遵循以下格式：
type(scope): short message
long message...
其中：
type可以为feat（新功能）、fix（修复问题）或chore（其他变动）。scope描述修改的范围，如cli,config, 或deps。
测试
项目使用 Jest 进行单元测试和集成测试。请在修改代码后运行：
npm test
贡献指南
欢迎贡献！如果你想改进此 CLI 工具，请按照标准的叉仓库和拉取请求流程进行操作。以下是一些注意事项：
- 确保你的代码符合项目的编码规范，包括使用 Prettier 进行格式化以及 ESLint 进行代码检查。
- 遵循
conventional commit格式编写提交信息。项目采用commitizen和commitlint结合@commitlint/config-conventional配置，并通过 Husky 设置预提交钩子进行验证。 - 为新功能或修复问题添加相应的测试用例。
CI/CD 自动化
测试
项目使用 Jest 进行单元测试和集成测试。请在修改代码后运行：
npm test
构建
项目采用 Webpack 进行构建，生成 umd、esm 和 cjs 格式的文件。
发布
要发布新版本，请按照以下步骤操作：
- 更新
CHANGELOG.md文件。 - 提交修改并推送到远程仓库。
- 使用 npm 脚本进行构建和发布：
npm run build
npm publish
📄 许可证
本项目使用 MIT 许可证，详细内容请查看 LICENSE 文件。