Merge remote-tracking branch 'origin/main'

Author: wonderwhy-er

README.md

@@ -1,6 +1,5 @@
 # Desktop Commander MCP
 
-
 [![npm downloads](https://img.shields.io/npm/dw/@wonderwhy-er/desktop-commander)](https://www.npmjs.com/package/@wonderwhy-er/desktop-commander)
 [![smithery badge](https://smithery.ai/badge/@wonderwhy-er/desktop-commander)](https://smithery.ai/server/@wonderwhy-er/desktop-commander)
 [![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-support-yellow.svg)](https://www.buymeacoffee.com/wonderwhyer)
@@ -51,21 +50,21 @@ This is server that allows Claude desktop app to execute long-running terminal c
 ## Installation
 First, ensure you've downloaded and installed the [Claude Desktop app](https://claude.ai/download) and you have [npm installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
 
-### Option 1: Installing via Smithery
+### Option 1: Install through npx
+Just run this in terminal
+```
+npx @wonderwhy-er/desktop-commander setup
+```
+Restart Claude if running
+
+### Option 2: Installing via Smithery
 
 To install Desktop Commander for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@wonderwhy-er/desktop-commander):
 
 ```bash
 npx -y @smithery/cli install @wonderwhy-er/desktop-commander --client claude
 ```
 
-### Option 2: Install trough npx
-Just run this in terminal
-```
-npx @wonderwhy-er/desktop-commander setup
-```
-Restart Claude if running
-
 ### Option 3: Add to claude_desktop_config by hand
 Add this entry to your claude_desktop_config.json:
 
@@ -122,7 +121,7 @@ The server provides these tool categories:
 - `move_file`: Move/rename files
 - `search_files`: Pattern-based file search
 - `get_file_info`: File metadata
-- `code_search`: Recursive ripgrep based text and code search
+- `search_code`: Recursive ripgrep based text and code search
 
 ### Edit Tools
 - `edit_block`: Apply surgical text replacements (best for changes <20% of file size)
@@ -132,9 +131,9 @@ Search/Replace Block Format:
 ```
 filepath.ext
 <<<<<<< SEARCH
-existing code to replace
+content to find
 =======
-new code to insert
+new content
 >>>>>>> REPLACE
 ```
 
@@ -264,6 +263,18 @@ No. This tool works with Claude Desktop's standard Pro subscription ($20/month),
 ### I'm having trouble installing or using the tool. Where can I get help?
 Join our [Discord server](https://discord.gg/kQ27sNnZr7) for community support, check the [GitHub issues](https://github.com/wonderwhy-er/ClaudeComputerCommander/issues) for known problems, or review the [full FAQ](FAQ.md) for troubleshooting tips. You can also visit our [website FAQ section](https://desktopcommander.app#faq) for a more user-friendly experience. If you encounter a new issue, please consider [opening a GitHub issue](https://github.com/wonderwhy-er/ClaudeComputerCommander/issues/new) with details about your problem.
 
+## Data Collection
+
+During installation and setup, Desktop Commander collects anonymous usage data to help improve the tool. This includes:
+- Operating system information
+- Node.js and NPM versions
+- Installation method and shell environment
+- Error messages (if any occur during setup)
+
+This data is collected using PostHog analytics and is associated with a machine-generated unique ID. No personal information is collected. This helps us understand how the tool is being used and identify common issues.
+
+We are currently working on adding a built-in opt-out option for this data collection in an upcoming release. For now, if you wish to opt out, you can block network connections to `eu.i.posthog.com` in your firewall settings.
+
 ## License
 
 MIT

docs/index.html

@@ -277,13 +277,13 @@ <h2>Installation</h2>
             </style>
 
             <div class="tabs">
-                <button class="tab-btn active" onclick="openTab(event, 'smithery')">Smithery Install</button>
-                <button class="tab-btn" onclick="openTab(event, 'npx')">NPX Install</button>
+                <button class="tab-btn active" onclick="openTab(event, 'npx')">NPX Install</button>
+                <button class="tab-btn" onclick="openTab(event, 'smithery')">Smithery Install</button>
                 <button class="tab-btn" onclick="openTab(event, 'manual')">Manual Configuration</button>
                 <button class="tab-btn" onclick="openTab(event, 'local')">Local Installation</button>
             </div>
 
-            <div id="smithery" class="tab-content active">
+            <div id="smithery" class="tab-content">
                 <div class="step">
                     <div class="step-content">
                         <h3>Smithery Install</h3>
@@ -293,7 +293,7 @@ <h3>Smithery Install</h3>
                 </div>
             </div>
 
-            <div id="npx" class="tab-content">
+            <div id="npx" class="tab-content active">
                 <div class="step">
                     <div class="step-content">
                         <h3>NPX Install</h3>
@@ -336,7 +336,6 @@ <h3>Local Installation</h3>
 </div>
 </div>
 <p style="margin-top: 10px; font-style: italic;">Remember to restart Claude after installation.</p>
-            
 
         </div>
     </section>

setup-claude-server.js

@@ -6,6 +6,7 @@ import { dirname } from 'path';
 import { exec } from "node:child_process";
 import { PostHog } from 'posthog-node';
 import machineId from 'node-machine-id';
+import { version as nodeVersion } from 'process';
 
 const client = new PostHog(
     'phc_TFQqTkCwtFGxlwkXDY3gSs7uvJJcJu8GurfXd6mV063',
@@ -18,14 +19,113 @@ const client = new PostHog(
 // Get a unique user ID
 const uniqueUserId = machineId.machineIdSync();
 
-client.capture({
+// Function to get npm version
+async function getNpmVersion() {
+  try {
+    return new Promise((resolve, reject) => {
+      exec('npm --version', (error, stdout, stderr) => {
+        if (error) {
+          resolve('unknown');
+          return;
+        }
+        resolve(stdout.trim());
+      });
+    });
+  } catch (error) {
+    return 'unknown';
+  }
+}
+
+// Function to detect shell environment
+function detectShell() {
+  // Check for Windows shells
+  if (process.platform === 'win32') {
+    if (process.env.TERM_PROGRAM === 'vscode') return 'vscode-terminal';
+    if (process.env.WT_SESSION) return 'windows-terminal';
+    if (process.env.SHELL?.includes('bash')) return 'git-bash';
+    if (process.env.TERM?.includes('xterm')) return 'xterm-on-windows';
+    if (process.env.ComSpec?.toLowerCase().includes('powershell')) return 'powershell';
+    if (process.env.PROMPT) return 'cmd';
+    
+    // WSL detection
+    if (process.env.WSL_DISTRO_NAME || process.env.WSLENV) {
+      return `wsl-${process.env.WSL_DISTRO_NAME || 'unknown'}`;
+    }
+
+    return 'windows-unknown';
+  }
+  
+  // Unix-based shells
+  if (process.env.SHELL) {
+    const shellPath = process.env.SHELL.toLowerCase();
+    if (shellPath.includes('bash')) return 'bash';
+    if (shellPath.includes('zsh')) return 'zsh';
+    if (shellPath.includes('fish')) return 'fish';
+    if (shellPath.includes('ksh')) return 'ksh';
+    if (shellPath.includes('csh')) return 'csh';
+    if (shellPath.includes('dash')) return 'dash';
+    return `other-unix-${shellPath.split('/').pop()}`;
+  }
+  
+  // Terminal emulators and IDE terminals
+  if (process.env.TERM_PROGRAM) {
+    return process.env.TERM_PROGRAM.toLowerCase();
+  }
+  
+  return 'unknown-shell';
+}
+
+// Function to determine execution context
+function getExecutionContext() {
+  // Check if running from npx
+  const isNpx = process.env.npm_lifecycle_event === 'npx' || 
+                process.env.npm_execpath?.includes('npx') ||
+                process.env._?.includes('npx') ||
+                import.meta.url.includes('node_modules');
+  
+  // Check if installed globally
+  const isGlobal = process.env.npm_config_global === 'true' ||
+                   process.argv[1]?.includes('node_modules/.bin');
+  
+  // Check if it's run from a script in package.json
+  const isNpmScript = !!process.env.npm_lifecycle_script;
+  
+  return {
+    runMethod: isNpx ? 'npx' : (isGlobal ? 'global' : (isNpmScript ? 'npm_script' : 'direct')),
+    isCI: !!process.env.CI || !!process.env.GITHUB_ACTIONS || !!process.env.TRAVIS || !!process.env.CIRCLECI,
+    shell: detectShell()
+  };
+}
+
+// Helper function to get standard environment properties for tracking
+let npmVersionCache = null;
+async function getTrackingProperties(additionalProps = {}) {
+  if (npmVersionCache === null) {
+    npmVersionCache = await getNpmVersion();
+  }
+  
+  const context = getExecutionContext();
+  
+  return {
+    platform: platform(),
+    nodeVersion: nodeVersion,
+    npmVersion: npmVersionCache,
+    executionContext: context.runMethod,
+    isCI: context.isCI,
+    shell: context.shell,
+    timestamp: new Date().toISOString(),
+    ...additionalProps
+  };
+}
+
+// Initial tracking
+(async () => {
+  client.capture({
     distinctId: uniqueUserId,
     event: 'npx_setup_start',
-    properties: {
-        platform: platform(),
-        timestamp: new Date().toISOString()
-    }
-});
+    properties: await getTrackingProperties()
+  });
+})();
 
 // Fix for Windows ESM path resolution
 const __filename = fileURLToPath(import.meta.url);
@@ -134,11 +234,7 @@ async function restartClaude() {
         client.capture({
             distinctId: uniqueUserId,
             event: 'npx_setup_restart_claude_error',
-            properties: {
-                platform: platform(),
-                timestamp: new Date().toISOString(),
-                error: error.message
-            }
+            properties: await getTrackingProperties({ error: error.message })
         });
 		logToFile(`Failed to restart Claude: ${error}`, true)
 	}
@@ -153,10 +249,7 @@ if (!existsSync(claudeConfigPath)) {
     client.capture({
         distinctId: uniqueUserId,
         event: 'npx_setup_create_default_config',
-        properties: {
-            platform: platform(),
-            timestamp: new Date().toISOString()
-        }
+        properties: await getTrackingProperties()
     });
 
     // Create the directory if it doesn't exist
@@ -232,10 +325,7 @@ export default async function setup() {
         client.capture({
             distinctId: uniqueUserId,
             event: 'npx_setup_update_config',
-            properties: {
-                platform: platform(),
-                timestamp: new Date().toISOString()
-            }
+            properties: await getTrackingProperties()
         });
         logToFile('Successfully added MCP server to Claude configuration!');
         logToFile(`Configuration location: ${claudeConfigPath}`);
@@ -246,21 +336,14 @@ export default async function setup() {
         client.capture({
             distinctId: uniqueUserId,
             event: 'npx_setup_complete',
-            properties: {
-                platform: platform(),
-                timestamp: new Date().toISOString()
-            }
+            properties: await getTrackingProperties()
         });
         await client.shutdown() 
     } catch (error) {
         client.capture({
             distinctId: uniqueUserId,
             event: 'npx_setup_final_error',
-            properties: {
-                platform: platform(),
-                timestamp: new Date().toISOString(),
-                error: error.message
-            }
+            properties: await getTrackingProperties({ error: error.message })
         });
         logToFile(`Error updating Claude configuration: ${error}`, true);
         await client.shutdown() 

src/server.ts

@@ -149,7 +149,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
         name: "read_file",
         description:
           "Read the complete contents of a file from the file system. " +
-          "Handles various text encodings and provides detailed error messages " +
+          "Reads UTF-8 text and provides detailed error messages " +
           "if the file cannot be read. Only works within allowed directories.",
         inputSchema: zodToJsonSchema(ReadFileArgsSchema),
       },
@@ -195,7 +195,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
       {
         name: "search_files",
         description:
-          "Recursively search for files and directories matching a pattern. " +
+          "Finds files by name using a case-insensitive substring matching. " +
           "Searches through all subdirectories from the starting path. " +
           "Only searches within allowed directories.",
         inputSchema: zodToJsonSchema(SearchFilesArgsSchema),
@@ -231,8 +231,8 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
         name: "edit_block",
         description:
             "Apply surgical text replacements to files. Best for small changes (<20% of file size). " +
-            "Multiple blocks can be used for separate changes. Will verify changes after application. " +
-            "Format: filepath, then <<<<<<< SEARCH, content to find, =======, new content, >>>>>>> REPLACE.",
+            "Call repeatedly to change multiple blocks. Will verify changes after application. " +
+            "Format:\nfilepath\n<<<<<<< SEARCH\ncontent to find\n=======\nnew content\n>>>>>>> REPLACE",
         inputSchema: zodToJsonSchema(EditBlockArgsSchema),
       },
     ],
@@ -428,4 +428,4 @@ server.setRequestHandler(CallToolRequestSchema, async (request: CallToolRequest)
       isError: true,
     };
   }
-});
+});