dbdesk-studio 0.1.2 → 0.1.4

package/README.md

@@ -23,7 +23,29 @@ npx dbdesk-studio
 
 ## Quick Start
 
-After running `dbdesk-studio`, the web interface will start at `http://localhost:3000`
+After running `dbdesk-studio`, the web interface will start at `http://localhost:9876`
+
+### Quick Connect with URI
+
+You can connect directly to a database using a connection URI:
+
+```bash
+# PostgreSQL
+npx dbdesk-studio --uri "postgresql://user:password@localhost:5432/mydb"
+
+# MySQL
+npx dbdesk-studio --uri "mysql://user:password@localhost:3306/mydb"
+
+# With SSL
+npx dbdesk-studio --uri "postgresql://user:password@localhost:5432/mydb?sslmode=require"
+```
+
+This will start the studio and automatically open your browser connected to the specified database.
+
+> ⚠️ **Security Note:** Passing credentials directly in the command line may expose them in shell history and process listings. For sensitive environments, consider:
+> - Using environment variables: `--uri "$DATABASE_URL"`
+> - Omitting the password and entering it in the UI
+> - Using `.pgpass` or similar credential files for your database
 
 ## Features
 
@@ -45,13 +67,27 @@ After running `dbdesk-studio`, the web interface will start at `http://localhost
 # Start the studio
 dbdesk-studio
 
+# Connect directly with a URI
+dbdesk-studio --uri "postgresql://user:pass@localhost:5432/mydb"
+
 # The web interface opens automatically
 # Default: http://localhost:9876
 ```
 
+## CLI Options
+
+```
+--uri <connection-string>  Database connection URI (opens directly to connection)
+                           Supports: postgresql://, postgres://, mysql://
+--backend-port <port>      Backend server port (default: 6789)
+--frontend-port <port>     Frontend server port (default: 9876)
+--backend-url <url>        Backend URL for frontend (default: http://localhost:6789)
+--help, -h                 Show help message
+```
+
 ## Configuration
 
-Set database connection details in the UI or use environment variables.
+Set database connection details directly in the web interface.
 
 ## License
 

package/dist/cli.js

@@ -9,7 +9,8 @@ const __dirname = dirname(__filename);
 const DEFAULT_CONFIG = {
     backendPort: 6789,
     frontendPort: 9876,
-    backendUrl: 'http://localhost:6789'
+    backendUrl: 'http://localhost:6789',
+    uri: undefined
 };
 function parseArgs() {
     const args = process.argv.slice(2);
@@ -33,9 +34,25 @@ function parseArgs() {
                 config.backendUrl = url;
             i++;
         }
-        else if (args[i] === '--help' || args[i] === '-h') {
-            printHelp();
-            process.exit(0);
+        else if (args[i] === '--uri') {
+            const next = args[i + 1];
+            if (!next || next.startsWith('-')) {
+                console.error('Error: --uri requires a value.');
+                printHelp();
+                process.exit(1);
+            }
+            config.uri = next;
+            i++;
+        }
+        else {
+            const arg = args[i];
+            if (arg && arg.startsWith('--uri=')) {
+                config.uri = arg.slice('--uri='.length);
+            }
+            else if (arg === '--help' || arg === '-h') {
+                printHelp();
+                process.exit(0);
+            }
         }
     }
     return config;
@@ -45,13 +62,17 @@ function printHelp() {
   Usage: dbdesk-studio [options]
 
   Options:
-    --backend-port <port>     Backend server port (default: 6789)
-    --frontend-port <port>    Frontend server port (default: 9876)
-    --backend-url <url>       Backend URL for frontend (default: http://localhost:6789)
-    --help, -h               Show this help message
+    --uri <connection-string>  Database connection URI (opens directly to connection)
+                               Supports: postgresql://, postgres://, mysql://
+    --backend-port <port>      Backend server port (default: 6789)
+    --frontend-port <port>     Frontend server port (default: 9876)
+    --backend-url <url>        Backend URL for frontend (default: http://localhost:6789)
+    --help, -h                 Show this help message
 
   Examples:
     dbdesk-studio
+    dbdesk-studio --uri "postgresql://user:pass@localhost:5432/mydb"
+    dbdesk-studio --uri="mysql://user:pass@localhost:3306/mydb"
     dbdesk-studio --backend-port 4000 --frontend-port 8080
     dbdesk-studio --backend-url http://api.example.com
   `);
@@ -179,11 +200,58 @@ async function main() {
             startBackend(config),
             startFrontend(config)
         ]);
-        console.log(`dbdesk-studio running at http://localhost:${config.frontendPort}`);
+        const baseUrl = `http://localhost:${config.frontendPort}`;
+        // If URI is provided, create connection via backend API first
+        if (config.uri) {
+            console.log('dbdesk-studio running...');
+            console.log('Creating connection from URI...');
+            try {
+                const connectionId = await createConnectionFromUri(config.uri, config.backendPort);
+                const appUrl = `${baseUrl}/connections/${connectionId}`;
+                console.log(`Connection created! Opening ${baseUrl}/connections/<id>`);
+                openBrowser(appUrl);
+            }
+            catch (err) {
+                console.error('Failed to create connection from URI:', err instanceof Error ? err.message : err);
+                console.log(`You can still access the studio at ${baseUrl}`);
+                openBrowser(baseUrl);
+            }
+        }
+        else {
+            console.log(`dbdesk-studio running at ${baseUrl}`);
+        }
     }
     catch (err) {
         console.error('❌ Failed to start services:', err);
         process.exit(1);
     }
 }
+async function createConnectionFromUri(uri, backendPort) {
+    const response = await fetch(`http://localhost:${backendPort}/api/connections/from-uri`, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({ uri })
+    });
+    if (!response.ok) {
+        const errorData = await response.json().catch(() => ({ error: 'Unknown error' }));
+        throw new Error(errorData.error || `HTTP ${response.status}`);
+    }
+    const profile = await response.json();
+    return profile.id;
+}
+function openBrowser(url) {
+    const platform = process.platform;
+    if (platform === 'darwin') {
+        spawn('open', [url], { stdio: 'ignore', detached: true }).unref();
+    }
+    else if (platform === 'win32') {
+        // 'start' is a cmd.exe builtin, not an executable
+        spawn('cmd.exe', ['/c', 'start', '""', url], { stdio: 'ignore', detached: true }).unref();
+    }
+    else {
+        spawn('xdg-open', [url], { stdio: 'ignore', detached: true }).unref();
+    }
+}
 main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdesk-studio",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Database management studio with a web interface",
   "type": "module",
   "bin": {
@@ -35,4 +35,4 @@
     "type": "git",
     "url": "https://github.com/zexahq/dbdesk-studio.git"
   }
-}
+}