Skip to content

CLI 命令参考

MyDeskBot CLI 提供了丰富的命令行工具,让您可以在终端中直接使用 MyDeskBot 的功能。

安装和设置

全局安装

bash
npm install -g mydeskbot-cli

验证安装

bash
mydeskbot --version
mydeskbot --help

基础命令

mydeskbot init

初始化一个新的 MyDeskBot 项目或工作空间。

bash
# 在当前目录初始化
mydeskbot init

# 指定项目类型
mydeskbot init --type=react

# 指定工作空间名称
mydeskbot init --name=my-project

# 使用默认配置
mydeskbot init --defaults

选项参数:

  • --type, -t: 项目类型 (react, vue, node, python, etc.)
  • --name, -n: 项目或工作空间名称
  • --defaults, -d: 使用默认配置
  • --force, -f: 强制覆盖现有配置

mydeskbot serve

启动 MyDeskBot 服务。

bash
# 启动服务(默认端口 3000)
mydeskbot serve

# 指定端口
mydeskbot serve --port=8080

# 指定主机
mydeskbot serve --host=0.0.0.0

# 开发模式
mydeskbot serve --dev

选项参数:

  • --port, -p: 指定端口号
  • --host, -h: 指定主机地址
  • --dev, -D: 开发模式
  • --watch, -w: 监听文件变化

项目管理

mydeskbot project

管理项目相关操作。

bash
# 列出所有项目
mydeskbot project list

# 创建新项目
mydeskbot project create --name=awesome-app --type=react

# 删除项目
mydeskbot project delete --name=awesome-app

# 项目信息
mydeskbot project info --name=awesome-app

mydeskbot workspace

管理工作空间。

bash
# 创建工作空间
mydeskbot workspace create --name=my-workspace --path=./src

# 切换工作空间
mydeskbot workspace switch --name=my-workspace

# 列出工作空间
mydeskbot workspace list

# 删除工作空间
mydeskbot workspace delete --name=my-workspace

AI 交互

mydeskbot chat

启动聊天界面或发送单个消息。

bash
# 启动交互式聊天
mydeskbot chat

# 发送单个消息
mydeskbot chat --message="帮我写一个 React 组件"

# 指定模型
mydeskbot chat --model=gpt-4 --message="解释这个函数"

# 从文件读取消息
mydeskbot chat --file=prompt.txt

选项参数:

  • --message, -m: 要发送的消息
  • --model: 指定使用的模型
  • --file, -f: 从文件读取消息内容
  • --output, -o: 将回复保存到文件

mydeskbot ask

快速提问,适用于简单查询。

bash
# 简单提问
mydeskbot ask "什么是 React Hooks?"

# 指定上下文
mydeskbot ask "这个函数有什么问题?" --context=./src/utils.js

# 获取代码建议
mydeskbot ask "如何优化这个函数?" --code

代码操作

mydeskbot generate

生成代码、文档等。

bash
# 生成组件
mydeskbot generate component --name=UserProfile --type=react

# 生成 API 客户端
mydeskbot generate api --spec=openapi.json --output=./src/api

# 生成文档
mydeskbot generate docs --source=./src --output=./docs

mydeskbot analyze

分析代码和项目。

bash
# 分析项目结构
mydeskbot analyze project --path=./src

# 分析代码质量
mydeskbot analyze quality --files=./src/**/*.js

# 分析依赖
mydeskbot analyze dependencies --tree

mydeskbot refactor

代码重构。

bash
# 重命名组件
mydeskbot refactor rename --old=OldComponent --new=NewComponent

# 提取函数
mydeskbot refactor extract --file=./src/utils.js --start=10 --end=20

# 优化导入
mydeskbot refactor imports --path=./src

配置管理

mydeskbot config

管理配置文件。

bash
# 查看当前配置
mydeskbot config show

# 设置配置项
mydeskbot config set model.default=gpt-4

# 获取配置项
mydeskbot config get model.default

# 重置配置
mydeskbot config reset

mydeskbot profile

管理配置文件。

bash
# 创建配置文件
mydeskbot profile create --name=development

# 切换配置文件
mydeskbot profile use --name=development

# 列出配置文件
mydeskbot profile list

# 删除配置文件
mydeskbot profile delete --name=development

模型管理

mydeskbot model

管理 AI 模型。

bash
# 列出可用模型
mydeskbot model list

# 模型信息
mydeskbot model info --name=gpt-4

# 测试模型
mydeskbot model test --name=gpt-4 --prompt="Hello, world!"

# 设置默认模型
mydeskbot model default --name=gpt-4

mydeskbot provider

管理模型提供商。

bash
# 添加提供商
mydeskbot provider add --name=openai --api-key=your-key

# 列出提供商
mydeskbot provider list

# 测试提供商
mydeskbot provider test --name=openai

# 删除提供商
mydeskbot provider delete --name=openai

工具和插件

mydeskbot plugin

管理插件。

bash
# 安装插件
mydeskbot plugin install @mydeskbot/plugin-react

# 卸载插件
mydeskbot plugin uninstall @mydeskbot/plugin-react

# 列出插件
mydeskbot plugin list

# 更新插件
mydeskbot plugin update @mydeskbot/plugin-react

mydeskbot tool

管理工具。

bash
# 启用工具
mydeskbot tool enable --name=file-manager

# 禁用工具
mydeskbot tool disable --name=file-manager

# 列出工具
mydeskbot tool list

# 工具信息
mydeskbot tool info --name=file-manager

数据管理

mydeskbot export

导出数据。

bash
# 导出对话历史
mydeskbot export conversations --format=json --output=chats.json

# 导出配置
mydeskbot export config --output=config.json

# 导出工作空间
mydeskbot export workspace --name=my-workspace --output=workspace.tar.gz

mydeskbot import

导入数据。

bash
# 导入对话历史
mydeskbot import conversations --file=chats.json

# 导入配置
mydeskbot import config --file=config.json

# 导入工作空间
mydeskbot import workspace --file=workspace.tar.gz

系统命令

mydeskbot doctor

诊断系统状态。

bash
# 完整诊断
mydeskbot doctor

# 检查特定组件
mydeskbot doctor --check=config,models,plugins

# 生成诊断报告
mydeskbot doctor --report --output=diagnostic.json

mydeskbot clean

清理系统。

bash
# 清理缓存
mydeskbot clean --cache

# 清理日志
mydeskbot clean --logs

# 清理临时文件
mydeskbot clean --temp

# 全部清理
mydeskbot clean --all

mydeskbot update

更新系统。

bash
# 检查更新
mydeskbot update --check

# 执行更新
mydeskbot update

# 更新到特定版本
mydeskbot update --version=1.2.0

高级用法

管道操作

bash
# 链式命令
mydeskbot generate component --name=Button | mydeskbot analyze quality

# 输出重定向
mydeskbot chat --message="写一个排序算法" > sort.js

批处理

bash
# 执行脚本文件
mydeskbot script --file=batch-commands.txt

# 并行执行
mydeskbot run --parallel --tasks="task1,task2,task3"

环境变量

bash
# 设置 API 密钥
export BYTEBUDDY_OPENAI_API_KEY="your-api-key"

# 设置默认模型
export BYTEBUDDY_DEFAULT_MODEL="gpt-4"

# 设置工作目录
export BYTEBUDDY_WORKSPACE="/path/to/workspace"

配置文件

全局配置

位置:~/.bytebuddy/config.json

json
{
  "defaultModel": "gpt-4",
  "workspace": "/home/user/projects",
  "providers": {
    "openai": {
      "apiKey": "${OPENAI_API_KEY}"
    }
  }
}

项目配置

位置:./.bytebuddy/config.json

json
{
  "type": "react",
  "model": "gpt-3.5-turbo",
  "rules": ["react-best-practices"],
  "tools": ["file-manager", "code-generator"]
}

故障排除

常见问题

命令未找到

bash
# 重新安装
npm uninstall -g mydeskbot-cli
npm install -g mydeskbot-cli

权限错误

bash
# 修复权限
sudo chown -R $(whoami) ~/.bytebuddy

网络问题

bash
# 使用代理
mydeskbot --proxy=http://proxy.example.com:8080 <command>

脚本示例

初始化脚本

bash
#!/bin/bash
# setup-mydeskbot.sh

# 创建新项目
mydeskbot init --type=react --name=$1

# 配置模型
mydeskbot config set model.default=gpt-4

# 安装插件
mydeskbot plugin install @mydeskbot/plugin-react
mydeskbot plugin install @mydeskbot/plugin-eslint

echo "MyDeskBot 项目初始化完成!"

部署脚本

bash
#!/bin/bash
# deploy.sh

# 分析代码质量
mydeskbot analyze quality --path=./src

# 生成文档
mydeskbot generate docs --source=./src --output=./docs

# 运行测试
mydeskbot test --coverage

echo "部署准备完成!"

这些命令让您可以在终端中高效地使用 MyDeskBot 的所有功能。