MyDeskBot

English

简体中文

English

简体中文

Appearance

Installation ​

Install MyDeskBot CLI on your system.

Prerequisites ​

  • Node.js 18 or higher
  • npm 9 or higher
  • Git (optional, for some features)

Install via npm ​

bash
npm install -g @mydeskbot/cli

Verify Installation ​

bash
mydeskbot --version

You should see the version number.

Quick Setup ​

1. Configure API Key ​

bash
mydeskbot config set apiKey "sk-..."

Or set environment variable:

bash
export OPENAI_API_KEY="sk-..."

2. Configure Model ​

bash
mydeskbot config set model "gpt-4o"

3. Test Installation ​

bash
mydeskbot ask "Hello, MyDeskBot!"

Package Managers ​

npm ​

bash
npm install -g @mydeskbot/cli

yarn ​

bash
yarn global add @mydeskbot/cli

pnpm ​

bash
pnpm add -g @mydeskbot/cli

Platform-Specific Installation ​

macOS ​

bash
# Using Homebrew (if available)
brew tap mydeskbot/tap
brew install mydeskbot-cli

# Or use npm
npm install -g @mydeskbot/cli

Linux ​

bash
# Using npm
npm install -g @mydeskbot/cli

# Using Debian/Ubuntu (deb package)
wget https://releases.mydeskbot.dev/cli/latest/mydeskbot-cli.deb
sudo dpkg -i mydeskbot-cli.deb

# Using Red Hat/Fedora (rpm package)
wget https://releases.mydeskbot.dev/cli/latest/mydeskbot-cli.rpm
sudo rpm -i mydeskbot-cli.rpm

Windows ​

bash
# Using npm
npm install -g @mydeskbot-cli

# Using Chocolatey
choco install mydeskbot-cli

# Using Scoop
scoop install mydeskbot-cli

Configuration File ​

MyDeskBot CLI looks for configuration in:

  1. ~/.mydeskbotrc (JSON)
  2. ~/.mydeskbot/config.json (JSON)
  3. ~/.mydeskbot.yml (YAML)
  4. ~/.mydeskbot.yaml (YAML)

Example Configuration ​

JSON (~/.mydeskbotrc):

json
{
  "apiKey": "sk-...",
  "model": "gpt-4o",
  "temperature": 1.0,
  "maxTokens": 4096
}

YAML (~/.mydeskbot.yml):

yaml
apiKey: sk-...
model: gpt-4o
temperature: 1.0
maxTokens: 4096

Environment Variables ​

MyDeskBot CLI supports environment variables:

bash
# API Keys
export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."
export GEMINI_API_KEY="AIza..."

# Model Settings
export MYDESKBOT_MODEL="gpt-4o"
export MYDESKBOT_TEMPERATURE="1.0"
export MYDESKBOT_MAX_TOKENS="4096"

# CLI Settings
export MYDESKBOT_LOG_LEVEL="info"
export MYDESKBOT_CACHE_DIR="~/.mydeskbot/cache"

Update ​

bash
npm update -g @mydeskbot/cli

Uninstall ​

bash
npm uninstall -g @mydeskbot-cli

Or using package managers:

bash
# Homebrew
brew uninstall mydeskbot-cli

# Chocolatey
choco uninstall mydeskbot-cli

# Scoop
scoop uninstall mydeskbot-cli

Troubleshooting ​

Command Not Found ​

Problem: mydeskbot: command not found

Solutions:

  1. Check npm global path:

    bash
    npm config get prefix

  2. Add npm global path to PATH:

    bash
    # macOS/Linux
export PATH=$(npm config get prefix)/bin:$PATH

# Windows
set PATH=%APPDATA%\npm;%PATH%

  3. Use npx (no installation needed):

    bash
    npx @mydeskbot/cli --version

Permission Denied ​

Problem: EACCES permission error

Solutions:

  1. Fix npm permissions:

    bash
    sudo chown -R $(whoami) ~/.npm

  2. Use npx instead (recommended):

    bash
    npx @mydeskbot/cli

API Key Issues ​

Problem: API key not working

Solutions:

  1. Check API key is set:

    bash
    mydeskbot config get apiKey

  2. Set API key:

    bash
    mydeskbot config set apiKey "sk-..."

  3. Check environment variable:

    bash
    echo $OPENAI_API_KEY

Shell Completion ​

Bash ​

Add to ~/.bashrc:

bash
source <(mydeskbot completion bash)

Zsh ​

Add to ~/.zshrc:

bash
source <(mydeskbot completion zsh)

Fish ​

Add to ~/.config/fish/completions/mydeskbot.fish:

bash
mydeskbot completion fish > ~/.config/fish/completions/mydeskbot.fish

PowerShell ​

Add to $PROFILE:

powershell
mydeskbot completion powershell | Out-String | Invoke-Expression

Next Steps ​

Need Help? ​

Copyright © 2026 MyDeskBot