Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ server.log

# Local planning/documentation directories
plans/
planning/

# Test output files
test/test_output/
19 changes: 19 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This document provides answers to the most commonly asked questions about Claude
- [How do I install Claude Desktop Commander?](#how-do-i-install-claude-desktop-commander)
- [How do I update to the latest version?](#how-do-i-update-to-the-latest-version)
- [Which operating systems does it support?](#which-operating-systems-does-it-support)
- [How do I get started after installing Desktop Commander?](#how-do-i-get-started-after-installing-desktop-commander)

- [Features & Capabilities](#features--capabilities)
- [What can I do with Claude Desktop Commander?](#what-can-i-do-with-claude-desktop-commander)
Expand Down Expand Up @@ -172,6 +173,24 @@ Claude Desktop Commander works with:

Work is in progress to improve WSL (Windows Subsystem for Linux) integration and add SSH support for remote servers.

### How do I get started after installing Desktop Commander?

After installation, Desktop Commander includes intelligent onboarding to help new users discover its capabilities:

**Automatic Onboarding:** When you're a new user (fewer than 10 successful commands), Claude will automatically offer helpful getting-started guidance and tutorials after you use Desktop Commander successfully.

**Manual Onboarding:** You can also request onboarding help at any time by simply asking Claude:
- "Help me get started with Desktop Commander"
- "Show me Desktop Commander examples"
- "What can I do with Desktop Commander?"

**Starter Examples:** Claude will show you beginner-friendly tutorials like:
- Organizing your Downloads folder
- Analyzing CSV files
- Setting up GitHub Actions
- Exploring codebases
- And more hands-on examples

## Features & Capabilities

### What can I do with Claude Desktop Commander?
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Work with code and text, run processes, and automate tasks, going far beyond oth
## Table of Contents
- [Features](#features)
- [How to install](#how-to-install)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Handling Long-Running Commands](#handling-long-running-commands)
- [Work in Progress and TODOs](#roadmap)
Expand Down Expand Up @@ -378,6 +379,28 @@ Close and restart Claude Desktop to complete the removal.
**Need help?**
- Join our Discord community: https://discord.com/invite/kQ27sNnZr7

## Getting Started

Once Desktop Commander is installed and Claude Desktop is restarted, you're ready to supercharge your Claude experience!

### 🚀 New User Onboarding

Desktop Commander includes intelligent onboarding to help you discover what's possible:

**For New Users:** When you're just getting started (fewer than 10 successful commands), Claude will automatically offer helpful getting-started guidance and practical tutorials after you use Desktop Commander successfully.

**Request Help Anytime:** You can ask for onboarding assistance at any time by simply saying:
- *"Help me get started with Desktop Commander"*
- *"Show me Desktop Commander examples"*
- *"What can I do with Desktop Commander?"*

Claude will then show you beginner-friendly tutorials and examples, including:
- 📁 Organizing your Downloads folder automatically
- 📊 Analyzing CSV/Excel files with Python
- ⚙️ Setting up GitHub Actions CI/CD
- 🔍 Exploring and understanding codebases
- 🤖 Running interactive development environments

## Usage

The server provides a comprehensive set of tools organized into several categories:
Expand Down
5 changes: 5 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1611,6 +1611,11 @@ <h4>Management Commands</h4>
</div>
<br />
<p style="margin-top: 10px; font-style: italic;">Remember to restart Claude after installation.</p>

<div style="background: #e8f4f8; padding: 20px; border-radius: 8px; margin: 20px 0; border-left: 4px solid var(--primary-color);">
<p style="margin: 0; color: #121212;"><strong>🚀 What's next?</strong> New to Desktop Commander? Simply ask Claude: <code style="background: #fff; padding: 2px 6px; border-radius: 4px; color: #333;">"What can I do with Desktop Commander?"</code> and you'll get guided tutorials and examples to discover what's possible!</p>
</div>

<br />
<div>
<h2>How to remove Desktop Commander</h2>
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"bump": "node scripts/sync-version.js --bump",
"bump:minor": "node scripts/sync-version.js --bump --minor",
"bump:major": "node scripts/sync-version.js --bump --major",
"build": "tsc && shx cp setup-claude-server.js uninstall-claude-server.js track-installation.js dist/ && shx chmod +x dist/*.js",
"build": "tsc && shx cp setup-claude-server.js uninstall-claude-server.js track-installation.js dist/ && shx chmod +x dist/*.js && shx mkdir -p dist/data && shx cp src/data/onboarding-prompts.json dist/data/",
"watch": "tsc --watch",
"start": "node dist/index.js",
"start:debug": "node --inspect-brk=9229 dist/index.js",
Expand Down
123 changes: 123 additions & 0 deletions src/data/onboarding-prompts.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
{
"version": "1.0.0",
"description": "Desktop Commander onboarding prompts for first-time users",
"prompts": [
{
"id": "onb_001",
"title": "Organize my Downloads folder",
"description": "Clean up and organize your messy Downloads folder into relevant subfolders automatically.",
"prompt": "Let's organize your Downloads folder! \n\nFirst, let me check what we're working with. I'll look at your Downloads folder to see how many files are there and what types.\n\nShould I start by analyzing your Downloads folder?",
"categories": ["onboarding"],
"secondaryTag": "Quick Start",
"votes": 0,
"gaClicks": 0,
"icon": "FolderOpen",
"author": "DC team",
"verified": true
},
{
"id": "onb_002",
"title": "Set up GitHub Actions CI/CD",
"description": "Set up GitHub Actions for your project to automatically run tests on every push with proper CI/CD workflow.",
"prompt": "Let's set up GitHub Actions CI/CD for your project! 🚀\n\n**What's the path to your project folder?**\n\n*Try: `~/work/my-project` (replace with your path) or give me a different path.*\n\nI'll analyze your project type and set up automated testing and deployment in about 15 minutes!",
"categories": ["onboarding"],
"secondaryTag": "Build & Deploy",
"votes": 0,
"gaClicks": 0,
"icon": "GitBranch",
"author": "DC team",
"verified": true
},
{
"id": "onb_003",
"title": "Create organized knowledge/documents folder",
"description": "Set up a well-structured knowledge base or document organization system with templates and suggested categories.",
"prompt": "Let's create an organized knowledge base! 📚\n\n**Where should I set it up?**\n\n*I suggest: `~/Documents/Knowledge-Base` (replace with your path) or give me a different location.*\n\nI'll create a clean folder structure with templates and organize any existing documents you have!",
"categories": ["onboarding"],
"secondaryTag": "Quick Start",
"votes": 0,
"gaClicks": 0,
"icon": "BookOpen",
"author": "DC team",
"verified": true
},
{
"id": "onb_004",
"title": "Explain codebase or repository to me",
"description": "Analyze and explain any codebase - local project or GitHub repository - including architecture, dependencies, and how it works.",
"prompt": "I'll analyze and explain any codebase for you! 🔍\n\n**What should I analyze?**\n\n*Local project:* `~/work/my-project` (replace with your path)\n*GitHub repo:* `https://github.com/user/repo`\n\nI'll break down the architecture, dependencies, and how everything works together!",
"categories": ["onboarding"],
"secondaryTag": "Code Analysis",
"votes": 0,
"gaClicks": 0,
"icon": "Code",
"author": "DC team",
"verified": true
},
{
"id": "onb_005",
"title": "Clean up unused code in my project",
"description": "Scan your codebase to find unused imports, dead functions, and redundant code that can be safely removed.",
"prompt": "Let's clean up unused code in your project! 🧹\n\n**What's your project folder path?**\n\n*Try: `~/work/my-project` (replace with your path)*\n\nI'll safely scan for dead code and unused imports, then show you exactly what can be removed before making any changes!",
"categories": ["onboarding"],
"secondaryTag": "Code Analysis",
"votes": 0,
"gaClicks": 0,
"icon": "Trash2",
"author": "DC team",
"verified": true
},
{
"id": "onb_006",
"title": "Build shopping list app and deploy online",
"description": "Create a simple shopping list web app from scratch and deploy it online - perfect for learning web development basics.",
"prompt": "Let's build a simple shopping list web app and deploy it online! 🛒\n\n**Quick question:** Where should I create the project folder?\n\n*I suggest using `~/Downloads/shopping-app` for quick testing, or give me a different path if you prefer.*\n\nOnce I have the folder, I'll build a working app step-by-step and get it online in about 20 minutes!",
"categories": ["onboarding"],
"secondaryTag": "Build & Deploy",
"votes": 0,
"gaClicks": 0,
"icon": "ShoppingCart",
"author": "DC team",
"verified": true
},
{
"id": "onb_007",
"title": "Analyze my data file",
"description": "Upload or point to any data file (CSV, JSON, Excel, etc.) and get comprehensive analysis including patterns, insights, and summary reports.",
"prompt": "I'll help you analyze your data file! \n\nWhat's the path to your data file? (e.g., `/Users/yourname/data.csv`)\n\nOnce you give me the path, I'll start by checking what type of file it is and show you a quick preview, then we can dive deeper step by step.",
"categories": ["onboarding"],
"secondaryTag": "Quick Start",
"votes": 0,
"gaClicks": 0,
"icon": "BarChart3",
"author": "DC team",
"verified": true
},
{
"id": "onb_008",
"title": "Check system health and resources",
"description": "Analyze your system's health, resource usage, running processes, and generate a comprehensive system status report.",
"prompt": "Let me check your system health and resources!\n\nI'll start by looking at your CPU, memory, and disk usage, then check for any performance issues.\n\nShould I begin the system analysis?",
"categories": ["onboarding"],
"secondaryTag": "Quick Start",
"votes": 0,
"gaClicks": 0,
"icon": "Activity",
"author": "DC team",
"verified": true
},
{
"id": "onb_009",
"title": "Find Patterns and Errors in Log Files",
"description": "Analyze log files to identify errors, patterns, performance issues, and security concerns with detailed insights and recommendations.",
"prompt": "I'll analyze your log files to find errors and patterns! 🔍\n\n**What log file should I analyze?**\n\n*Try: `/var/log/system.log` (macOS/Linux) or `~/app.log`, or I can search for logs on your system.*\n\nI'll find errors, performance issues, and suspicious patterns with actionable recommendations!",
"categories": ["onboarding"],
"secondaryTag": "Code Analysis",
"votes": 0,
"gaClicks": 0,
"icon": "Search",
"author": "DC team",
"verified": true
}
]
}
Loading