@abyrd9/harbor-cli 0.1.1 → 1.0.0

package/README.md

@@ -3,8 +3,7 @@
 A CLI tool for those small side projects that only run a few services. Harbor allows you to:
 
 1. 🛠️ Define your services in a configuration file
-2. 🔄 Generate a Caddyfile to reverse proxy certain services to subdomains
-3. 🚀 Launch your services in a tmux session with Caddy and your services automatically proxied
+2. 🚀 Launch your services in a tmux session
 
 ## Installation
 
@@ -16,7 +15,6 @@ npm i -g @abyrd9/harbor-cli
 
 Before using Harbor, make sure you have the following installed:
 
-- [Caddy](https://caddyserver.com/docs/install) (for reverse proxy)
 - [tmux](https://github.com/tmux/tmux/wiki/Installing) (for terminal multiplexing)
 - [jq](https://stedolan.github.io/jq/download/) (for JSON processing within tmux)
 
@@ -32,74 +30,45 @@ harbor dock
 harbor moor
 ```
 
-3. Update your Caddyfile:
-```bash
-harbor anchor
-```
-
-4. Launch your services:
+3. Launch your services:
 ```bash
 harbor launch
 ```
 
 ## Configuration
 
-Harbor uses two main configuration files:
+Harbor uses a configuration file to manage your services:
 
 ### harbor.json
 
-Contains your service configurations that are used to generate the Caddyfile and launch the services:
+Contains your service configurations that are used to launch the services:
 
 ```json
 {
-  "domain": "localhost",
   "services": [
     {
       "name": "frontend",
       "path": "./vite-frontend",
-      "command": "npm run dev",
-      "port": 3000,
-      "subdomain": "app"
+      "command": "npm run dev"
     },
     {
       "name": "api",
       "path": "./go-api",
-      "command": "go run .",
-      "port": 8080,
-      "subdomain": "api"
+      "command": "go run ."
     },
     {
       "name": "dashboard",
       "path": "./vite-frontend",
-      "command": "npx drizzle-kit studio",
+      "command": "npx drizzle-kit studio"
     }
   ]
 }
 ```
 
-> Note: The dashboard service is a bit special. This is a drizzle studio instance to view your database. There's no subdomain value and no port declared because it typically runs at `local.drizzle.studio`. This will still be running and viewable in your tmux session, but it won't be automatically proxied.
-
-### Caddyfile
-
-Automatically generated reverse proxy configuration:
-
-```caddy
-api.localhost {
-    reverse_proxy localhost:8080
-}
-
-app.localhost {
-    reverse_proxy localhost:3000
-}
-```
-
-> Note: Some services may be tricky with Caddy and getting HMR to work or whatever other problems. Feel free to tinker with the Caddyfile or the subdomain values in the harbor config file in order to get things running. Maybe in the future there will be examples for common cases.
-
 ## Commands
 
 - `harbor dock`: Generate a new harbor.json file
 - `harbor moor`: Add new services to your harbor.json file
-- `harbor anchor`: Update your Caddyfile from the current harbor.json file
 - `harbor launch`: Start all services defined in your harbor.json file in a tmux session
 
 ## Terminal Multiplexer

package/dist/index.js

@@ -11,12 +11,6 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const packageJson = JSON.parse(readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8'));
 const requiredDependencies = [
-    {
-        name: 'Caddy',
-        command: 'caddy version',
-        installMsg: 'https://caddyserver.com/docs/install',
-        requiredFor: 'reverse proxy functionality',
-    },
     {
         name: 'tmux',
         command: 'tmux -V',
@@ -73,13 +67,11 @@ program
     .description(`A CLI tool for managing your project's local development services
 
 Harbor helps you manage multiple local development services with ease.
-It provides a simple way to configure and run your services with automatic
-subdomain routing through Caddy reverse proxy.
+It provides a simple way to configure and run your services in tmux sessions.
 
 Available Commands:
   dock      Initialize a new Harbor project
   moor      Add new services to your configuration
-  anchor    Generate Caddy reverse proxy configuration
   launch    Start all services in tmux sessions`)
     .version(packageJson.version)
     .action(async () => await checkDependencies())
@@ -89,48 +81,22 @@ if (process.argv.length <= 2) {
     program.help();
 }
 program.command('dock')
-    .description(`Prepares your development environment by creating both:
+    .description(`Prepares your development environment by creating a harbor configuration file
 - harbor.json configuration file (or harbor field in package.json)
-- Caddyfile for reverse proxy (if needed)
 	
 This is typically the first command you'll run in a new project.`)
     .option('-p, --path <path>', 'The path to the root of your project', './')
     .action(async (options) => {
     try {
-        const caddyFileExists = fileExists('Caddyfile');
         const configExists = checkHasHarborConfig();
-        if (caddyFileExists || configExists) {
+        if (configExists) {
             console.log('❌ Error: Harbor project already initialized');
-            if (caddyFileExists) {
-                console.log('   - Caddyfile already exists');
-            }
-            if (configExists) {
-                console.log('   - Harbor configuration already exists');
-            }
-            console.log('\nTo reinitialize, please remove these files first.');
+            console.log('   - Harbor configuration already exists');
+            console.log('\nTo reinitialize, please remove the configuration first.');
             process.exit(1);
         }
-        const servicesAdded = await generateDevFile(options.path);
-        // Only try to generate Caddyfile if services were actually added
-        if (servicesAdded) {
-            try {
-                await generateCaddyFile();
-                console.log('✨ Environment successfully prepared and anchored!');
-            }
-            catch (err) {
-                if (err instanceof Error && err.message.includes('No harbor configuration found')) {
-                    // This is expected if no services were added
-                    console.log('✨ Environment prepared! No services configured yet.');
-                }
-                else {
-                    console.log('❌ Error generating Caddyfile:', err instanceof Error ? err.message : 'Unknown error');
-                    process.exit(1);
-                }
-            }
-        }
-        else {
-            console.log('✨ Environment prepared! No services configured yet.');
-        }
+        await generateDevFile(options.path);
+        console.log('✨ Environment prepared!');
     }
     catch (err) {
         console.log('❌ Error:', err instanceof Error ? err.message : 'Unknown error');
@@ -149,19 +115,6 @@ program.command('moor')
     }
     await generateDevFile(options.path);
 });
-program.command('anchor')
-    .description(`Add new services to your Caddyfile
-
-Note: This command will stop any active Caddy processes, including those from other Harbor projects.`)
-    .action(async () => {
-    if (!checkHasHarborConfig()) {
-        console.log('❌ No harbor configuration found');
-        console.log('\nTo initialize a new Harbor project, please use:');
-        console.log('  harbor dock');
-        process.exit(1);
-    }
-    await generateCaddyFile();
-});
 program.command('launch')
     .description(`Launch your services in the harbor terminal multiplexer (Using tmux)
 
@@ -184,9 +137,6 @@ function isProjectDirectory(dirPath) {
     });
 }
 function validateConfig(config) {
-    if (!config.domain) {
-        return 'Domain is required';
-    }
     if (!Array.isArray(config.services)) {
         return 'Services must be an array';
     }
@@ -227,8 +177,6 @@ async function generateDevFile(dirPath) {
                     // If package.json exists but no harbor config, use it
                     writeToPackageJson = true;
                     config = {
-                        domain: 'localhost',
-                        useSudo: false,
                         services: [],
                     };
                     console.log('Creating new harbor config in package.json...');
@@ -236,8 +184,6 @@ async function generateDevFile(dirPath) {
                 else {
                     // No package.json, create harbor.json
                     config = {
-                        domain: 'localhost',
-                        useSudo: false,
                         services: [],
                     };
                     console.log('Creating new harbor.json...');
@@ -249,8 +195,6 @@ async function generateDevFile(dirPath) {
                 }
                 // No package.json, create harbor.json
                 config = {
-                    domain: 'localhost',
-                    useSudo: false,
                     services: [],
                 };
                 console.log('Creating new harbor.json...');
@@ -268,7 +212,6 @@ async function generateDevFile(dirPath) {
                     const service = {
                         name: folder.name,
                         path: folderPath,
-                        subdomain: folder.name.toLowerCase().replace(/\s+/g, ''),
                     };
                     // Try to determine default command based on project type
                     if (fs.existsSync(path.join(folderPath, 'package.json'))) {
@@ -291,25 +234,6 @@ async function generateDevFile(dirPath) {
         }
         if (!newServicesAdded) {
             console.log('No new services found to add, feel free to add them manually');
-            // Still write the initial config even if no services were found
-            const validationError = validateConfig(config);
-            if (validationError) {
-                throw new Error(`Invalid harbor configuration: ${validationError}`);
-            }
-            if (writeToPackageJson) {
-                // Update package.json
-                const packageData = await fs.promises.readFile('package.json', 'utf-8');
-                const packageJson = JSON.parse(packageData);
-                packageJson.harbor = config;
-                await fs.promises.writeFile('package.json', JSON.stringify(packageJson, null, 2), 'utf-8');
-                console.log('\npackage.json updated successfully with harbor configuration');
-            }
-            else {
-                // Write to harbor.json
-                await fs.promises.writeFile('harbor.json', JSON.stringify(config, null, 2), 'utf-8');
-                console.log('\nharbor.json created successfully');
-            }
-            return false;
         }
         const validationError = validateConfig(config);
         if (validationError) {
@@ -329,7 +253,6 @@ async function generateDevFile(dirPath) {
             console.log('\nharbor.json created successfully');
         }
         console.log('\nImportant:');
-        console.log('  - Update the \'Port\' field for each service to match its actual port or leave blank to ignore in the Caddyfile');
         console.log('  - Verify the auto-detected commands are correct for your services');
         return true;
     }
@@ -373,60 +296,6 @@ async function readHarborConfig() {
     }
     throw new Error('No harbor configuration found in harbor.json or package.json');
 }
-async function stopCaddy() {
-    try {
-        console.log('\n⚠️  Stopping any existing Caddy processes...');
-        console.log('   This will interrupt any active Harbor or Caddy services\n');
-        // Try to kill any existing Caddy processes
-        await new Promise((resolve) => {
-            const isWindows = process.platform === 'win32';
-            const killCommand = isWindows ? 'taskkill /F /IM caddy.exe' : 'pkill caddy';
-            const childProcess = spawn('sh', ['-c', killCommand]);
-            childProcess.on('close', () => {
-                // It's okay if there was no process to kill (code 1)
-                resolve();
-            });
-        });
-        // Give it a moment to fully release ports
-        await new Promise(resolve => setTimeout(resolve, 1000));
-    }
-    catch (err) {
-        // Ignore errors as the process might not exist
-    }
-}
-async function generateCaddyFile() {
-    try {
-        const config = await readHarborConfig();
-        let caddyfileContent = '';
-        // Check if any services need a Caddyfile
-        const needsCaddyfile = config.services.some(svc => svc.port && svc.subdomain);
-        if (!needsCaddyfile) {
-            // If no services need a Caddyfile, remove it if it exists
-            if (fileExists('Caddyfile')) {
-                await fs.promises.unlink('Caddyfile');
-                console.log('Removed Caddyfile as no services require subdomains');
-            }
-            return;
-        }
-        for (const svc of config.services) {
-            if (!svc.port || !svc.subdomain) {
-                continue;
-            }
-            const serverName = `${svc.subdomain}.${config.domain}`;
-            caddyfileContent += `${serverName} {\n`;
-            caddyfileContent += `  reverse_proxy localhost:${svc.port}\n`;
-            caddyfileContent += "}\n\n";
-        }
-        await fs.promises.writeFile('Caddyfile', caddyfileContent, 'utf-8');
-        // Stop existing Caddy process before proceeding
-        await stopCaddy();
-        console.log('Caddyfile generated successfully');
-    }
-    catch (err) {
-        console.error('Error generating Caddyfile:', err);
-        process.exit(1);
-    }
-}
 async function runServices() {
     const hasHarborConfig = checkHasHarborConfig();
     if (!hasHarborConfig) {
@@ -449,18 +318,6 @@ async function runServices() {
         console.error('Error reading config:', err);
         process.exit(1);
     }
-    // Check if any services need a Caddyfile
-    const needsCaddyfile = config.services.some(svc => svc.port && svc.subdomain);
-    if (needsCaddyfile && !fileExists('Caddyfile')) {
-        console.log('❌ No Caddyfile found, but some services require subdomains');
-        console.log('\nTo generate the Caddyfile:');
-        console.log('  harbor anchor');
-        process.exit(1);
-    }
-    // Stop any existing Caddy process if we need it
-    if (needsCaddyfile) {
-        await stopCaddy();
-    }
     // Ensure scripts exist and are executable
     await ensureScriptsExist();
     // Execute the script directly using spawn to handle I/O streams

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@abyrd9/harbor-cli",
-  "version": "0.1.1",
-  "description": "A CLI tool for managing local development services with automatic subdomain routing",
+  "version": "1.0.0",
+  "description": "A CLI tool for managing simple local development services with tmux sessions",
   "type": "module",
   "bin": {
     "harbor": "dist/index.js"
@@ -21,8 +21,6 @@
   "keywords": [
     "cli",
     "development",
-    "proxy",
-    "caddy",
     "tmux",
     "local-development"
   ],
@@ -49,22 +47,16 @@
   },
   "main": "index.js",
   "harbor": {
-    "domain": "localhost",
-    "useSudo": true,
     "services": [
       {
         "name": "vite-project",
         "path": "test-services/vite-project",
-        "subdomain": "vite-project",
-        "command": "npm run dev",
-        "port": 5173
+        "command": "npm run dev"
       },
       {
         "name": "go-api",
         "path": "test-services/go-api",
-        "subdomain": "go-api",
-        "command": "go run .",
-        "port": 8080
+        "command": "go run ."
       }
     ]
   }

package/scripts/dev.sh

@@ -79,36 +79,8 @@ tmux set-option -g 'status-format[0]' ''
 echo "Creating window for interactive shell"
 tmux rename-window -t local-dev-test:0 'Terminal'
 
-# Check if any services need Caddy
-needs_caddy=false
-echo "Checking for services that need Caddy..."
-if get_harbor_config | jq -e '.services[] | select(.subdomain != null and .port != null) | true' > /dev/null; then
-    needs_caddy=true
-    echo "Found services that need Caddy"
-fi
-echo "needs_caddy value: $needs_caddy"
-
 window_index=1  # Start from index 1
 
-# Create a new window for Caddy if needed
-if [ "$needs_caddy" = true ]; then
-    echo "Creating window for Caddy"
-    tmux new-window -t local-dev-test:1 -n 'Caddy'
-    
-    # Check if useSudo is true in harbor config
-    use_sudo=$(get_harbor_config | jq -r '.useSudo // false')
-    echo "useSudo value: $use_sudo"
-    if [ "$use_sudo" = "true" ]; then
-        echo "Running Caddy with sudo"
-        tmux send-keys -t local-dev-test:1 'sudo caddy run' C-m
-    else
-        echo "Running Caddy without sudo"
-        tmux send-keys -t local-dev-test:1 'caddy run' C-m
-    fi
-    
-    window_index=2  # Start services from index 2
-fi
-
 # Create windows dynamically based on harbor config
 get_harbor_config | jq -c '.services[]' | while read service; do
     name=$(echo $service | jq -r '.name')