CLI 安装指南

MyDeskBot 命令行界面（CLI）提供强大的 AI 辅助工具，让您在终端中享受智能开发体验。

系统要求

最低要求

操作系统:
- macOS 10.15+ (Catalina)
- Windows 10+
- Linux (glibc 2.17+)
运行时:
- Node.js 18.0 或更高版本
- npm 9.0 或更高版本

安装方法

方法 1: 使用 npm（推荐）

全局安装

bash

npm install -g @mydeskbot/cli

检查安装

bash

mydeskbot --version

方法 2: 使用 Yarn

bash

yarn global add @mydeskbot/cli

方法 3: 使用 pnpm

bash

pnpm add -g @mydeskbot/cli

方法 4: 使用 Homebrew (macOS)

bash

brew install mydeskbot/tap/mydeskbot

方法 5: 下载二进制文件

macOS

bash

# 下载最新版本
curl -L https://github.com/mydeskbot/cli/releases/latest/download/mydeskbot-darwin-amd64.tar.gz -o mydeskbot.tar.gz

# 解压
tar -xzf mydeskbot.tar.gz

# 移动到 PATH
sudo mv mydeskbot /usr/local/bin/

# 设置执行权限
sudo chmod +x /usr/local/bin/mydeskbot

Linux

bash

# 下载最新版本
curl -L https://github.com/mydeskbot/cli/releases/latest/download/mydeskbot-linux-amd64.tar.gz -o mydeskbot.tar.gz

# 解压
tar -xzf mydeskbot.tar.gz

# 移动到 PATH
sudo mv mydeskbot /usr/local/bin/

# 设置执行权限
sudo chmod +x /usr/local/bin/mydeskbot

Windows

powershell

# 使用 PowerShell 下载
Invoke-WebRequest -Uri "https://github.com/mydeskbot/cli/releases/latest/download/mydeskbot-windows-amd64.zip" -OutFile "mydeskbot.zip"

# 解压
Expand-Archive -Path mydeskbot.zip -DestinationPath .

# 添加到 PATH（手动操作或使用以下命令）
# 将解压后的目录添加到系统 PATH 环境变量

方法 6: 从源代码构建

bash

# 克隆仓库
git clone https://github.com/mydeskbot/cli.git
cd cli

# 安装依赖
npm install

# 构建
npm run build

# 链接到全局
npm link

验证安装

检查版本

bash

mydeskbot --version
# 输出: MyDeskBot CLI v1.0.0

查看帮助

bash

mydeskbot --help

测试连接

bash

mydeskbot test

查看 API 密钥状态

bash

mydeskbot config show

初始配置

设置 API 密钥

交互式配置

bash

mydeskbot config init

按照提示输入：

API 密钥
API 基础 URL（可选）
默认模型（可选）
代理设置（可选）

直接配置

bash

# 设置 OpenAI API 密钥
mydeskbot config set api.key sk-your-api-key-here

# 设置 API 基础 URL
mydeskbot config set api.base https://api.openai.com/v1

# 设置默认模型
mydeskbot config set model gpt-4

使用环境变量

bash

# Bash/Zsh
export MYDESKBOT_API_KEY="sk-your-api-key-here"

# PowerShell
$env:MYDESKBOT_API_KEY="sk-your-api-key-here"

# 永久设置（添加到 ~/.bashrc 或 ~/.zshrc）
echo 'export MYDESKBOT_API_KEY="sk-your-api-key-here"' >> ~/.bashrc

配置代理

bash

# 设置 HTTP 代理
mydeskbot config set proxy.http http://127.0.0.1:7890

# 设置 HTTPS 代理
mydeskbot config set proxy.https https://127.0.0.1:7890

# 使用环境变量
export HTTP_PROXY=http://127.0.0.1:7890
export HTTPS_PROXY=https://127.0.0.1:7890

查看配置

bash

# 查看所有配置
mydeskbot config show

# 查看特定配置
mydeskbot config get api.key
mydeskbot config get model

升级和卸载

升级

使用 npm

bash

# 全局升级
npm update -g @mydeskbot/cli

# 或重新安装
npm install -g @mydeskbot/cli@latest

使用 Yarn

bash

yarn global upgrade @mydeskbot/cli

使用 Homebrew

bash

brew upgrade mydeskbot/tap/mydeskbot

使用二进制文件

bash

# 下载新版本并覆盖旧文件
curl -L https://github.com/mydeskbot/cli/releases/latest/download/mydeskbot-darwin-amd64.tar.gz -o mydeskbot.tar.gz
tar -xzf mydeskbot.tar.gz
sudo mv mydeskbot /usr/local/bin/

卸载

使用 npm

bash

npm uninstall -g @mydeskbot/cli

使用 Yarn

bash

yarn global remove @mydeskbot/cli

使用 Homebrew

bash

brew uninstall mydeskbot

手动卸载

bash

# 删除二进制文件
sudo rm /usr/local/bin/mydeskbot

# 删除配置文件
rm -rf ~/.mydeskbot

# 删除缓存
rm -rf ~/.cache/mydeskbot

清理数据

bash

# 清除缓存
mydeskbot cache clear

# 清除配置
mydeskbot config clear

# 完全重置（包括配置和缓存）
mydeskbot reset --all

故障排除

问题 1: 找不到命令

症状:

bash

mydeskbot --version
# command not found: mydeskbot

解决方案:

bash

# 检查安装路径
which node
which mydeskbot

# 检查 npm 全局路径
npm config get prefix

# 将 npm 全局路径添加到 PATH
export PATH=$(npm config get prefix)/bin:$PATH

# 永久添加（添加到 ~/.bashrc 或 ~/.zshrc）
echo 'export PATH=$(npm config get prefix)/bin:$PATH' >> ~/.bashrc

问题 2: 权限错误

症状:

bash

npm install -g @mydeskbot/cli
# Error: EACCES

解决方案:

bash

# 方案 1: 使用 sudo（不推荐）
sudo npm install -g @mydeskbot/cli

# 方案 2: 修改 npm 全局目录（推荐）
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
npm install -g @mydeskbot/cli

问题 3: Node.js 版本不兼容

症状:

bash

npm install -g @mydeskbot/cli
# Error: requires Node.js version >= 18.0.0

解决方案:

bash

# 使用 nvm 安装 Node.js 18+
nvm install 18
nvm use 18
npm install -g @mydeskbot/cli

问题 4: 网络连接问题

症状:

bash

mydeskbot ask "Hello"
# Error: Failed to connect to API

解决方案:

bash

# 检查网络连接
ping api.openai.com

# 配置代理
mydeskbot config set proxy.http http://127.0.0.1:7890

# 检查 API 密钥
mydeskbot config get api.key

# 测试连接
mydeskbot test

配置文件位置

配置文件路径

平台	配置文件路径
macOS/Linux	`~/.mydeskbot/config.json`
Windows	`%APPDATA%\MyDeskBot\config.json`

缓存路径

平台	缓存路径
macOS/Linux	`~/.cache/mydeskbot/`
Windows	`%LOCALAPPDATA%\MyDeskBot\cache\`

环境变量

变量名	说明
`MYDESKBOT_API_KEY`	API 密钥
`MYDESKBOT_API_BASE`	API 基础 URL
`MYDESKBOT_MODEL`	默认模型
`MYDESKBOT_CONFIG`	配置文件路径
`HTTP_PROXY`	HTTP 代理
`HTTPS_PROXY`	HTTPS 代理

下一步

快速开始 - 开始使用 CLI
命令参考 - 查看所有命令
配置指南 - 深入配置

CLI 安装指南 ​

目录 ​

系统要求 ​

最低要求 ​

推荐配置 ​

安装方法 ​

方法 1: 使用 npm（推荐） ​

全局安装 ​

检查安装 ​

方法 2: 使用 Yarn ​

方法 3: 使用 pnpm ​

方法 4: 使用 Homebrew (macOS) ​

方法 5: 下载二进制文件 ​

macOS ​

Linux ​

Windows ​

方法 6: 从源代码构建 ​

验证安装 ​

检查版本 ​

查看帮助 ​

测试连接 ​

查看 API 密钥状态 ​

初始配置 ​

设置 API 密钥 ​

交互式配置 ​

直接配置 ​

使用环境变量 ​

配置代理 ​

查看配置 ​

升级和卸载 ​

升级 ​

使用 npm ​

使用 Yarn ​

使用 Homebrew ​

使用二进制文件 ​

卸载 ​

使用 npm ​

使用 Yarn ​

使用 Homebrew ​

手动卸载 ​

清理数据 ​

故障排除 ​

问题 1: 找不到命令 ​

问题 2: 权限错误 ​

问题 3: Node.js 版本不兼容 ​

问题 4: 网络连接问题 ​

配置文件位置 ​

配置文件路径 ​

缓存路径 ​

环境变量 ​

下一步 ​

获取帮助 ​

CLI 安装指南

目录

系统要求

最低要求

推荐配置

安装方法

方法 1: 使用 npm（推荐）

全局安装

检查安装

方法 2: 使用 Yarn

方法 3: 使用 pnpm

方法 4: 使用 Homebrew (macOS)

方法 5: 下载二进制文件

macOS

Linux

Windows

方法 6: 从源代码构建

验证安装

检查版本

查看帮助

测试连接

查看 API 密钥状态

初始配置

设置 API 密钥

交互式配置

直接配置

使用环境变量

配置代理

查看配置

升级和卸载

升级

使用 npm

使用 Yarn

使用 Homebrew

使用二进制文件

卸载

使用 npm

使用 Yarn

使用 Homebrew

手动卸载

清理数据

故障排除

问题 1: 找不到命令

问题 2: 权限错误

问题 3: Node.js 版本不兼容

问题 4: 网络连接问题

配置文件位置

配置文件路径

缓存路径

环境变量

下一步

获取帮助