git-push-deploy-cli 0.1.0 → 0.2.0

package/README.md

@@ -1,43 +1,47 @@
 # git-push-deploy-cli (gpd)
 
-Git Push Deploy - A CLI for git-based deployments with PM2/systemd support. Push to deploy Node.js applications using bare git repositories and post-receive hooks.
+Git Push Deploy - A CLI for git-based deployments with PM2 support. Push to deploy Node.js applications via SSH.
 
 ## Features
 
-- **Git-based deployment**: Push to deploy using bare repositories
-- **PM2 integration**: Automatic process management and restarts
-- **Monorepo support**: Stage multiple packages for deployment
-- **Cross-platform**: Works on Linux servers and Windows/Mac dev machines
+- **Git-based deployment**: Push to bare repo, server hook handles install
+- **PM2 integration**: Automatic process restarts with user isolation
+- **Lazy initialization**: Deploy repo created on first `gpd stage`
+- **SSH orchestration**: Server setup from your dev machine
 - **Config-driven**: Define services in `.git-deploy.json`
 
 ## Installation
 
 ```bash
-# Global installation (recommended for servers)
 npm install -g git-push-deploy-cli
-
-# Or use npx
-npx git-push-deploy-cli <command>
 ```
 
 ## Quick Start
 
-### 1. Create config file
-
-Create `.git-deploy.json` in your workspace root:
+### 1. Create `.git-deploy.json` in your workspace root:
 
 ```json
 {
   "services": {
-    "my-api": {
-      "packages": ["my-api"],
-      "mainPackage": "my-api",
-      "deployRepo": "../deploy-my-api",
-      "pm2Name": "my-api",
+    "my-api-staging": {
+      "sourceDir": "my-api",
+      "deployRepo": "deploy/staging",
+      "artifacts": ["dist/index.js", "package.json", "ecosystem.config.cjs"],
+      "processManager": "pm2",
+      "processName": "my-api-staging",
+      "pm2Home": "/opt/myapp/.pm2",
+      "pm2User": "myapp",
+      "environment": "staging",
+      "env": {
+        "PORT": 5000,
+        "NODE_ENV": "staging"
+      },
       "server": {
-        "targetDir": "/opt/myapp/my-api",
-        "bareRepo": "/git/deploy-my-api",
-        "user": "myapp"
+        "host": "user@myserver",
+        "sshOptions": "-p 22",
+        "targetDir": "/opt/myapp/staging/my-api",
+        "bareRepo": "/git/deploy-myapp/staging/my-api",
+        "group": "deploy-myapp"
       }
     }
   }
@@ -47,140 +51,115 @@ Create `.git-deploy.json` in your workspace root:
 ### 2. Initialize server (once per service)
 
 ```bash
-# On the server
-sudo gpd init my-api
+gpd init my-api-staging
 ```
 
-This creates:
-- Bare git repository at `/git/deploy-my-api`
-- Post-receive hook for automatic deployment
-- Log file at `/var/log/deploy-my-api.log`
-- Unix group `deploy-my-api` with appropriate permissions
+This creates via SSH:
+- Bare git repository at `/git/deploy-myapp/staging/my-api`
+- Target directory at `/opt/myapp/staging/my-api`
+- Post-receive hook that calls `gpd install`
 
-### 3. Deploy from dev machine
+### 3. Deploy
 
 ```bash
-# Build, stage, and push
-gpd deploy my-api
-
-# Or step by step:
-gpd stage my-api    # Copy build artifacts to deploy repo
-gpd release my-api  # Commit and push
+gpd deploy my-api-staging
 ```
 
-## Commands
+This:
+1. Creates deploy repo (if needed) at `my-api/deploy/staging/`
+2. Copies build artifacts to deploy repo
+3. Commits and pushes to bare repo on server
+4. Server hook: `git checkout && npm install && pm2 restart`
 
-### Development Commands
+## Commands
 
 | Command | Description |
 |---------|-------------|
+| `gpd status` | Show all configured services |
 | `gpd stage <service>` | Copy build artifacts to deploy repo |
 | `gpd release <service>` | Commit and push deploy repo |
-| `gpd deploy <service>` | Stage + release in one step |
-
-### Server Commands
+| `gpd deploy <service>` | Stage + release (hook handles install) |
+| `gpd init <service>` | Initialize server (bare repo, target dir, hook) |
+| `gpd install <service>` | Server-side install (called by hook) |
+| `gpd logs <service>` | Show PM2 logs from server via SSH |
 
-| Command | Description |
-|---------|-------------|
-| `gpd init <service>` | Initialize bare repo, hook, and permissions |
-| `gpd install <service>` | Extract, npm install, pm2 restart (used by hook) |
-| `gpd status` | Show all services and PM2 status |
-| `gpd logs <service>` | Show deployment logs |
+## Options
 
-## Configuration
-
-### .git-deploy.json
+```bash
+gpd deploy my-api -m "custom commit message"
+gpd deploy my-api --skip-push      # Only stage, do not push
+gpd logs my-api -f                 # Follow logs
+gpd logs my-api -n 100             # Show last 100 lines
+```
 
-```json
-{
-  "services": {
-    "<service-name>": {
-      "packages": ["pkg1", "pkg2"],
-      "mainPackage": "pkg1",
-      "deployRepo": "../deploy-<service>",
-      "pm2Name": "<pm2-process-name>",
-      "pm2Home": "/opt/myapp/.pm2",
-      "artifacts": ["dist", "package.json", "package-lock.json"],
-      "server": {
-        "targetDir": "/opt/myapp/<service>",
-        "bareRepo": "/git/deploy-<service>",
-        "user": "myapp",
-        "group": "deploy-<service>"
-      }
-    }
-  }
+## Config Reference
+
+```typescript
+interface ServiceConfig {
+  sourceDir: string;         // Project directory (e.g., "my-api")
+  deployRepo: string;        // Deploy repo path, relative to sourceDir
+  artifacts: string[];       // Files/dirs to copy
+  processManager: 'pm2';     // Process manager type
+  processName: string;       // PM2 process name
+  pm2Home?: string;          // PM2_HOME on server
+  pm2User?: string;          // User to run PM2 as (sudo -u)
+  environment?: string;      // staging | production
+  env?: Record<string, any>; // Environment variables for .env file
+  server: {
+    host: string;            // SSH host (user@hostname)
+    sshOptions?: string;     // SSH options (e.g., "-p 6771 -4")
+    targetDir: string;       // Target directory on server
+    bareRepo: string;        // Bare repo path on server
+    group?: string;          // Unix group for permissions
+  };
 }
 ```
 
-### Configuration Options
-
-| Option | Required | Description |
-|--------|----------|-------------|
-| `packages` | Yes | Packages to deploy (monorepo support) |
-| `mainPackage` | Yes | Package with package.json for npm install |
-| `deployRepo` | Yes | Path to local deploy repository |
-| `pm2Name` | Yes | PM2 process name |
-| `pm2Home` | No | PM2 home directory (default: ~/.pm2) |
-| `artifacts` | No | Files/dirs to copy (default: dist, package.json, package-lock.json) |
-| `server.targetDir` | Yes | Where to install on server |
-| `server.bareRepo` | Yes | Path to bare git repo on server |
-| `server.user` | No | Unix user for file ownership |
-| `server.group` | No | Unix group (default: deploy-<service>) |
-
-## How It Works
+## Architecture
 
 ```
-[Dev Machine]                    [Server]
-     │                               │
-     │  npm run build                │
-     ▼                               │
-┌─────────────┐                      │
-│ dist/       │                      │
-│ package.json│                      │
-└─────────────┘                      │
-     │                               │
-     │  git-deploy stage             │
-     ▼                               │
-┌─────────────┐                      │
-│ deploy-repo/│                      │
-│  └─ my-api/ │                      │
-└─────────────┘                      │
-     │                               │
-     │  git-deploy release           │
-     │  (git push)                   │
-     ▼                               ▼
-              ─────────────────────►
-                                ┌─────────────┐
-                                │ bare repo   │
-                                │ post-receive│
-                                └─────────────┘
-                                     │
-                                     │  git-deploy install
-                                     ▼
-                                ┌─────────────┐
-                                │ /opt/myapp/ │
-                                │ npm install │
-                                │ pm2 restart │
-                                └─────────────┘
+Workspace                              Server
+─────────                              ──────
+my-api/
+├── src/                               /git/deploy-myapp/staging/my-api/
+├── dist/                                └── hooks/post-receive
+└── deploy/                                   ↓
+    └── staging/                       /opt/myapp/staging/my-api/
+        ├── .git → ssh://...           ├── dist/index.js
+        ├── dist/                      ├── package.json
+        └── package.json               ├── node_modules/
+                                       └── .env (generated)
 ```
 
-## Integration with npm scripts
+## Workflow
 
-```json
-{
-  "scripts": {
-    "predeploy": "npm version patch && npm run build",
-    "deploy": "gpd deploy my-api"
-  }
-}
+```
+Dev Machine                           Server
+───────────                           ──────
+gpd deploy my-api-staging
+  │
+  ├─ gpd stage
+  │    └─ Copy artifacts → my-api/deploy/staging/
+  │
+  └─ gpd release  
+       └─ git push ───────────────→ /git/deploy-myapp/staging/my-api
+                                          │
+                                          └─ post-receive hook:
+                                               gpd install my-api-staging
+                                                 │
+                                                 ├─ git checkout -f
+                                                 ├─ .env generation
+                                                 ├─ npm install --omit=dev
+                                                 └─ pm2 restart
 ```
 
-## Requirements
+## Server Prerequisites
 
-- Node.js >= 18
+- Node.js + npm
+- PM2 (`npm install -g pm2`)
+- gpd CLI (`npm install -g git-push-deploy-cli`)
+- SSH access from dev machine
 - Git
-- PM2 (on server)
-- Linux server (Debian, Ubuntu, Raspberry Pi OS, etc.)
 
 ## License
 

package/dist/commands/deploy.d.ts

@@ -1,8 +1,16 @@
 interface DeployOptions {
     message?: string;
+    skipPush?: boolean;
 }
 /**
- * Deploy command - stage and release in one step
+ * Deploy command - stage artifacts and push to server
+ *
+ * New architecture:
+ * 1. Stage: Copy build artifacts to deploy repo (with lazy init)
+ * 2. Release: Commit and push to bare repo on server
+ * 3. Server hook handles: git checkout, npm install, pm2 restart
+ *
+ * No more SSH install from client - the post-receive hook does everything!
  */
 export declare function deployCommand(serviceName: string, options?: DeployOptions): Promise<void>;
 export {};

package/dist/commands/deploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAGA,UAAU,aAAa;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAGnG"}
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAKA,UAAU,aAAa;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBnG"}

package/dist/commands/deploy.js

@@ -1,10 +1,37 @@
+import chalk from 'chalk';
 import { stageCommand } from './stage.js';
 import { releaseCommand } from './release.js';
+import { getServiceConfig } from '../config/loader.js';
 /**
- * Deploy command - stage and release in one step
+ * Deploy command - stage artifacts and push to server
+ *
+ * New architecture:
+ * 1. Stage: Copy build artifacts to deploy repo (with lazy init)
+ * 2. Release: Commit and push to bare repo on server
+ * 3. Server hook handles: git checkout, npm install, pm2 restart
+ *
+ * No more SSH install from client - the post-receive hook does everything!
  */
 export async function deployCommand(serviceName, options = {}) {
+    const config = getServiceConfig(serviceName);
+    console.log(chalk.blue.bold(`Deploying ${serviceName}...`));
+    console.log(chalk.gray(`  Environment: ${config.environment || 'production'}`));
+    console.log(chalk.gray(`  Server: ${config.server.host}`));
+    console.log('');
+    // 1. Stage artifacts to deploy repo
     await stageCommand(serviceName);
-    await releaseCommand(serviceName, options);
+    console.log('');
+    // 2. Commit and push (triggers server-side hook)
+    if (!options.skipPush) {
+        await releaseCommand(serviceName, options);
+        console.log('');
+        console.log(chalk.green.bold(`✓ Deployed ${serviceName}`));
+        console.log(chalk.gray('  The server hook will handle: git checkout, npm install, pm2 restart'));
+        console.log(chalk.gray(`  Check logs: gpd logs ${serviceName}`));
+    }
+    else {
+        console.log(chalk.yellow('Skipped push (--skip-push). Run manually:'));
+        console.log(chalk.white(`  gpd release ${serviceName}`));
+    }
 }
 //# sourceMappingURL=deploy.js.map

package/dist/commands/deploy.js.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAM9C;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,WAAmB,EAAE,UAAyB,EAAE;IAClF,MAAM,YAAY,CAAC,WAAW,CAAC,CAAC;IAChC,MAAM,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC"}
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAOvD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,WAAmB,EAAE,UAAyB,EAAE;IAClF,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAE7C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,WAAW,KAAK,CAAC,CAAC,CAAC;IAC5D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,MAAM,CAAC,WAAW,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC;IAChF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3D,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAEhB,oCAAoC;IACpC,MAAM,YAAY,CAAC,WAAW,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAEhB,iDAAiD;IACjD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,MAAM,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,WAAW,EAAE,CAAC,CAAC,CAAC;QAC3D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC,CAAC;QACjG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,0BAA0B,WAAW,EAAE,CAAC,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,2CAA2C,CAAC,CAAC,CAAC;QACvE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,iBAAiB,WAAW,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC"}

package/dist/commands/init.d.ts

@@ -1,9 +1,13 @@
 interface InitOptions {
-    users?: string;
 }
 /**
- * Init command - initialize bare repo, hook, and permissions on server
+ * Init command - initialize bare repo and target directory on remote server via SSH
+ *
+ * Creates:
+ * 1. Bare repo at server.bareRepo (e.g., /git/sym/deploy-kairox/staging/kairox-api)
+ * 2. Target directory at server.targetDir (e.g., /opt/kairox/staging/kairox-api)
+ * 3. Post-receive hook that calls `gpd install <service>`
  */
-export declare function initCommand(serviceName: string, options?: InitOptions): Promise<void>;
+export declare function initCommand(serviceName: string, _options?: InitOptions): Promise<void>;
 export {};
 //# sourceMappingURL=init.d.ts.map

package/dist/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAOA,UAAU,WAAW;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAmID;;GAEG;AACH,wBAAsB,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAqF/F"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAIA,UAAU,WAAW;CAEpB;AA8DD;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA6EhG"}