ClaudeComputerCommander
Language:
TypeScript
Stars:
1.7K
Forks:
173
README
Desktop Commander MCP
Search, update, manage files and run terminal commands with AI
Work with code and text, run processes, and automate tasks, going far beyond other AI editors - while using host client subscriptions instead of API token costs.
Table of Contents
- Features
- How to install
- Getting Started
- Usage
- Handling Long-Running Commands
- Work in Progress and TODOs
- Sponsors and Supporters
- Website
- Media
- Testimonials
- Frequently Asked Questions
- Contributing
- License
All of your AI development tools in one place. Desktop Commander puts all dev tools in one chat. Execute long-running terminal commands on your computer and manage processes through Model Context Protocol (MCP). Built on top of MCP Filesystem Server to provide additional search and replace file editing capabilities.
Features
- Enhanced terminal commands with interactive process control
- Execute code in memory (Python, Node.js, R) without saving files
- Instant data analysis - just ask to analyze CSV/JSON/Excel files
- Native Excel file support - Read, write, edit, and search Excel files (.xlsx, .xls, .xlsm) without external tools
- PDF support - Read PDFs with text extraction, create new PDFs from markdown, modify existing PDFs
- Interact with running processes (SSH, databases, development servers)
- Execute terminal commands with output streaming
- Command timeout and background execution support
- Process management (list and kill processes)
- Session management for long-running commands
- Server configuration management:
- Get/set configuration values
- Update multiple settings at once
- Dynamic configuration changes without server restart
- Full filesystem operations:
- Read/write files (text, Excel, PDF)
- Create/list directories
- Move files/directories
- Search files and content (including Excel content)
- Get file metadata
- Negative offset file reading: Read from end of files using negative offset values (like Unix tail)
- Code editing capabilities:
- Surgical text replacements for small changes
- Full file rewrites for major changes
- Multiple file support
- Pattern-based replacements
- vscode-ripgrep based recursive code or text search in folders
- Comprehensive audit logging:
- All tool calls are automatically logged
- Log rotation with 10MB size limit
- Detailed timestamps and arguments
How to install
Desktop Commander offers multiple installation methods to fit different user needs and technical requirements.
📋 Update & Uninstall Information: Before choosing an installation option, note that only Options 1, 2, 3, and 6 have automatic updates. Options 4 and 5 require manual updates. See the sections below for update and uninstall instructions for each option.
Option 1: Install through npx ⭐ Auto-Updates Requires Node.js
Just run this in terminal:
npx @wonderwhy-er/desktop-commander@latest setup
For debugging mode (allows Node.js inspector connection):
npx @wonderwhy-er/desktop-commander@latest setup --debug
Command line options during setup:
--debug: Enable debugging mode for Node.js inspector--no-onboarding: Disable onboarding prompts for new users
Restart Claude if running.
✅ Auto-Updates: Yes - automatically updates when you restart Claude
🔄 Manual Update: Run the setup command again
🗑️ Uninstall: Run npx @wonderwhy-er/desktop-commander@latest remove
Option 2: Using bash script installer (macOS) ⭐ Auto-Updates Installs Node.js if needed
For macOS users, you can use our automated bash installer which will check your Node.js version, install it if needed, and automatically configure Desktop Commander:
curl -fsSL https://raw.githubusercontent.com/wonderwhy-er/DesktopCommanderMCP/refs/heads/main/install.sh | bash
This script handles all dependencies and configuration automatically for a seamless setup experience.
✅ Auto-Updates: Yes - requires manual updates
🔄 Manual Update: Re-run the bash installer command above
🗑️ Uninstall: Run npx @wonderwhy-er/desktop-commander@latest remove
Option 3: Installing via Smithery ⭐ Auto-Updates Requires Node.js
To install Desktop Commander for Claude Desktop via Smithery:
- Visit the Smithery page: https://smithery.ai/server/@wonderwhy-er/desktop-commander
- Login to Smithery if you haven't already
- Select your client (Claude Desktop) on the right side
- Install with the provided key that appears after selecting your client
- Restart Claude Desktop
The old command-line installation method is no longer supported. Please use the web interface above for the most reliable installation experience.
✅ Auto-Updates: Yes - automatically updates when you restart Claude
🔄 Manual Update: Visit the Smithery page and reinstall
Option 4: Add to claude_desktop_config manually ⭐ Auto-Updates Requires Node.js
Add this entry to your claude_desktop_config.json:
- On Mac:
~/Library/Application\ Support/Claude/claude_desktop_config.json - On Windows:
%APPDATA%\Claude\claude_desktop_config.json - On Linux:
~/.config/Claude/claude_desktop_config.json
{
"mcpServers": {
"desktop-commander": {
"command": "npx",
"args": [
"-y",
"@wonderwhy-er/desktop-commander@latest"
]
}
}
}
Restart Claude if running.
✅ Auto-Updates: Yes - automatically updates when you restart Claude
🔄 Manual Update: Run the setup command again
🗑️ Uninstall: Run npx @wonderwhy-er/desktop-commander@latest remove or remove the "desktop-commander" entry from your claude_desktop_config.json file
### Option 5: Checkout locally ❌ Manual Updates Requires Node.js ❌ Manual Updates Requires Node.js
- Clone and build:
git clone https://github.com/wonderwhy-er/DesktopCommanderMCP.git cd DesktopCommanderMCP npm run setupRestart Claude if running.
The setup command will:
- Install dependencies
- Build the server
- Configure Claude's desktop app
- Add MCP servers to Claude's config if needed
❌ Auto-Updates: No - requires manual git updates
🔄 Manual Update: cd DesktopCommanderMCP && git pull && npm run setup
🗑️ Uninstall: Run npx @wonderwhy-er/desktop-commander@latest remove or remove the cloned directory and remove MCP server entry from Claude config
Option 6: Docker Installation 🐳 ⭐ Auto-Updates No Node.js Required
Perfect for users who want complete or partial isolation or don't have Node.js installed. Desktop Commander runs in a sandboxed Docker container with a persistent work environment.
Prerequisites
- Docker Desktop installed and running
- Claude Desktop app installed
Important: Make sure Docker Desktop is fully started before running the installer.
Automated Installation (Recommended)
macOS/Linux:
bash **For comprehensive security information and vulnerability reporting**: See [SECURITY.md](SECURITY.md)
1. **Known security limitations**: Directory restrictions and command blocking can be bypassed through various methods including symlinks, command substitution, and absolute paths or code execution
2. **Always change configuration in a separate chat window** from where you're doing your actual work. Claude may sometimes attempt to modify configuration settings (like `allowedDirectories`) if it encounters filesystem access restrictions.
3. **The `allowedDirectories` setting currently only restricts filesystem operations**, not terminal commands. Terminal commands can still access files outside allowed directories.
4. **For production security**: Use the [Docker installation](#option-6-docker-installation-🐳-⭐-auto-updates-no-nodejs-required) which provides complete isolation from your host system.
### Configuration Tools
You can manage server configuration using the provided tools:
```javascript
// Get the entire config
get_config({})
// Set a specific config value
set_config_value({ "key": "defaultShell", "value": "/bin/zsh" })
// Set multiple config values using separate calls
set_config_value({ "key": "defaultShell", "value": "/bin/bash" })
set_config_value({ "key": "allowedDirectories", "value": ["/Users/username/projects"] })
The configuration is saved to config.json in the server's working directory and persists between server restarts.
Understanding fileWriteLineLimit
The fileWriteLineLimit setting controls how many lines can be written in a single write_file operation (default: 50 lines). This limit exists for several important reasons:
Why the limit exists:
- AIs are wasteful with tokens: Instead of doing two small edits in a file, AIs may decide to rewrite the whole thing. We're trying to force AIs to do things in smaller changes as it saves time and tokens
- Claude UX message limits: There are limits within one message and hitting "Continue" does not really work. What we're trying here is to make AI work in smaller chunks so when you hit that limit, multiple chunks have succeeded and that work is not lost - it just needs to restart from the last chunk
Setting the limit:
// You can set it to thousands if you want
set_config_value({ "key": "fileWriteLineLimit", "value": 1000 })
// Or keep it smaller to force more efficient behavior
set_config_value({ "key": "fileWriteLineLimit", "value": 25 })
Maximum value: You can set it to thousands if you want - there's no technical restriction.
Best practices:
- Keep the default (50) to encourage efficient AI behavior and avoid token waste
- The system automatically suggests chunking when limits are exceeded
- Smaller chunks mean less work lost when Claude hits message limits
Best Practices
-
Create a dedicated chat for configuration changes: Make all your config changes in one chat, then start a new chat for your actual work.
-
Be careful with empty
allowedDirectories: Setting this to an empty array ([]) grants access to your entire filesystem for file operations. -
Use specific paths: Instead of using broad paths like
/, specify exact directories you want to access. -
Always verify configuration after changes: Use
get_config({})to confirm your changes were applied correctly.
Command Line Options
Desktop Commander supports several command line options for customizing behavior:
Disable Onboarding
By default, Desktop Commander shows helpful onboarding prompts to new users (those with fewer than 10 tool calls). You can disable this behavior:
# Disable onboarding for this session
node dist/index.js --no-onboarding
# Or if using npm scripts
npm run start:no-onboarding
# For npx installations, modify your claude_desktop_config.json:
{
"mcpServers": {
"desktop-commander": {
"command": "npx",
"args": [
"-y",
"@wonderwhy-er/desktop-commander@latest",
"--no-onboarding"
]
}
}
}
When onboarding is automatically disabled:
- When the MCP client name is set to "desktop-commander"
- When using the
--no-onboardingflag - After users have used onboarding prompts or made 10+ tool calls
Debug information:
The server will log when onboarding is disabled: "Onboarding disabled via --no-onboarding flag"
Using Different Shells
You can specify which shell to use for command execution:
// Using default shell (bash or system default)
execute_command({ "command": "echo $SHELL" })
// Using zsh specifically
execute_command({ "command": "echo $SHELL", "shell": "/bin/zsh" })
// Using bash specifically
execute_command({ "command": "echo $SHELL", "shell": "/bin/bash" })
This allows you to use shell-specific features or maintain consistent environments across commands.
execute_commandreturns after timeout with initial output- Command continues in background
- Use
read_outputwith PID to get new output - Use
force_terminateto stop if needed
Debugging
If you need to debug the server, you can install it in debug mode:
# Using npx
npx @wonderwhy-er/desktop-commander@latest setup --debug
# Or if installed locally
npm run setup:debug
This will:
- Configure Claude to use a separate "desktop-commander" server
- Enable Node.js inspector protocol with
--inspect-brk=9229flag - Pause execution at the start until a debugger connects
- Enable additional debugging environment variables
To connect a debugger:
- In Chrome, visit
chrome://inspectand look for the Node.js instance - In VS Code, use the "Attach to Node Process" debug configuration
- Other IDEs/tools may have similar "attach" options for Node.js debugging
Important debugging notes:
- The server will pause on startup until a debugger connects (due to the
--inspect-brkflag) - If you don't see activity during debugging, ensure you're connected to the correct Node.js process
- Multiple Node processes may be running; connect to the one on port 9229
- The debug server is identified as "desktop-commander-debug" in Claude's MCP server list
Troubleshooting:
- If Claude times out while trying to use the debug server, your debugger might not be properly connected
- When properly connected, the process will continue execution after hitting the first breakpoint
- You can add additional breakpoints in your IDE once connected
Model Context Protocol Integration
This project extends the MCP Filesystem Server to enable:
- Local server support in Claude Desktop
- Full system command execution
- Process management
- File operations
- Code editing with search/replace blocks
Created as part of exploring Claude MCPs: https://youtube.com/live/TlbjFDbl5Us
Support Desktop Commander
📢 SUPPORT THIS PROJECT Desktop Commander MCP is free and open source, but needs your support to thrive!
Our philosophy is simple: we don't want you to pay for it if you're not successful. But if Desktop Commander contributes to your success, please consider contributing to ours.
Ways to support:
🌟 GitHub Sponsors - Recurring support
☕ Buy Me A Coffee - One-time contributions
💖 Patreon - Become a patron and support us monthly
⭐ Star on GitHub - Help others discover the project
❤️ Supporters Hall of Fame
Generous supporters are featured here. Thank you for helping make this project possible!
Jon Richards
Matija Stepanic
Why your support matters Your support allows us to:
Continue active development and maintenance
Add new features and integrations
Improve compatibility across platforms
Provide better documentation and examples
Build a stronger community around the project
Website
Visit our official website at https://desktopcommander.app/ for the latest information, documentation, and updates.
Media
Learn more about this project through these resources:
Article
Claude with MCPs replaced Cursor & Windsurf. How did that happen? - A detailed exploration of how Claude with Model Context Protocol capabilities is changing developer workflows.
Video
Claude Desktop Commander Video Tutorial - Watch how to set up and use the Commander effectively.
Publication at AnalyticsIndiaMag
This Developer Ditched Windsurf, Cursor Using Claude with MCPs
Community
Join our Discord server to get help, share feedback, and connect with other users.
Testimonials
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=UgyyBt6_ShdDX_rIOad4AaABAg
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=UgztdHvDMqTb9jiqnf54AaABAg
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=UgyQFTmYLJ4VBwIlmql4AaABAg
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=Ugy4-exy166_Ma7TH-h4AaABAg
https://medium.com/@pharmx/you-sir-are-my-hero-62cff5836a3e
If you find this project useful, please consider giving it a ⭐ star on GitHub! This helps others discover the project and encourages further development.
We welcome contributions from the community! Whether you've found a bug, have a feature request, or want to contribute code, here's how you can help:
- Found a bug? Open an issue at github.com/wonderwhy-er/DesktopCommanderMCP/issues
- Have a feature idea? Submit a feature request in the issues section
- Want to contribute code? Fork the repository, create a branch, and submit a pull request
- Questions or discussions? Start a discussion in the GitHub Discussions tab
All contributions, big or small, are greatly appreciated!
If you find this tool valuable for your workflow, please consider supporting the project.
Frequently Asked Questions
Here are answers to some common questions. For a more comprehensive FAQ, see our detailed FAQ document.
What is Desktop Commander?
It's an MCP tool that enables Claude Desktop to access your file system and terminal, turning Claude into a versatile assistant for coding, automation, codebase exploration, and more.
How is this different from Cursor/Windsurf?
Unlike IDE-focused tools, Claude Desktop Commander provides a solution-centric approach that works with your entire OS, not just within a coding environment. Claude reads files in full rather than chunking them, can work across multiple projects simultaneously, and executes changes in one go rather than requiring constant review.
Do I need to pay for API credits?
No. This tool works with Claude Desktop's standard Pro subscription ($20/month), not with API calls, so you won't incur additional costs beyond the subscription fee.
Does Desktop Commander automatically update?
Yes, when installed through npx or Smithery, Desktop Commander automatically updates to the latest version when you restart Claude. No manual update process is needed.
What are the most common use cases?
- Exploring and understanding complex codebases
- Generating diagrams and documentation
- Automating tasks across your system
- Working with multiple projects simultaneously
- Making surgical code changes with precise control
I'm having trouble installing or using the tool. Where can I get help?
Join our Discord server for community support, check the GitHub issues for known problems, or review the full FAQ for troubleshooting tips. You can also visit our website FAQ section for a more user-friendly experience. If you encounter a new issue, please consider opening a GitHub issue with details about your problem.
How do I report security vulnerabilities?
Please create a GitHub Issue with detailed information about any security vulnerabilities you discover. See our Security Policy for complete guidelines on responsible disclosure.
Data Collection & Privacy
Desktop Commander collects limited, pseudonymous telemetry to improve the tool. We do not collect file contents, file paths, or command arguments.
Opt-out: Ask Claude to "disable Desktop Commander telemetry" or set "telemetryEnabled": false in your config.
For complete details, see our Privacy Policy.
Verifications
License
MIT