dokku-compose 0.6.9 → 0.6.11

package/README.md

@@ -176,7 +176,7 @@ apps:
 
 ### Docker Options
 
-Add custom Docker options per build phase (`build`, `deploy`, `run`). Each phase is cleared and re-populated on every `up` for idempotent convergence.
+Add custom Docker options per build phase (`build`, `deploy`, `run`). Options are converged with targeted add/remove — only changed options are modified, preserving entries managed by other resources (e.g. `--link`, `--build-arg`).
 
 ```yaml
 apps:
@@ -411,8 +411,10 @@ dokku-compose down --force           # Destroy all configured apps
 |--------|-------------|
 | `--file <path>` | Config file (default: `dokku-compose.yml`) |
 | `--dry-run` | Print commands without executing |
+| `--sensitive` | Show sensitive values in output (masked by default) |
 | `--fail-fast` | Stop on first error (default: continue to next app) |
 | `--remove-orphans` | Destroy services and networks not in config |
+| `--verbose` | Show git-style +/- diff (diff command only) |
 | `--help` | Show usage |
 | `--version` | Show version |
 
@@ -429,14 +431,14 @@ dokku-compose ps                      # Show status
 ## Execution Modes
 
 ```bash
-# Run locally on the Dokku server
-dokku-compose up
-
-# Run remotely over SSH
+# Run remotely over SSH (recommended)
 DOKKU_HOST=my-server.example.com dokku-compose up
+
+# Run on the Dokku server itself (use DOKKU_HOST=localhost for best compatibility)
+DOKKU_HOST=localhost dokku-compose up
 ```
 
-When `DOKKU_HOST` is set, all Dokku commands are sent over SSH. This is the typical workflow — keep `dokku-compose.yml` in your project repo and apply it from your local machine. SSH key access to the Dokku server is required.
+When `DOKKU_HOST` is set, all Dokku commands are sent over SSH. This is the recommended mode — it works both remotely from your local machine and directly on the server. SSH mode avoids compatibility issues with Dokku's basher environment that can affect some commands when called directly from Node.js. SSH key access to the Dokku server is required.
 
 ## What `up` Does
 

package/dist/index.js

@@ -1062,6 +1062,37 @@ async function runExport(ctx, opts) {
   return config;
 }
 
+// src/core/mask.ts
+var SENSITIVE_RE = /(?:TOKEN|SECRET|PASSWORD|KEY|AUTH|CREDENTIAL)/i;
+function maskValue(value) {
+  if (value.length <= 4) return "****";
+  return `****${value.slice(-4)}`;
+}
+function maskSensitiveArgs(cmd) {
+  return cmd.replace(/([^\s=]*(?:TOKEN|SECRET|PASSWORD|KEY|AUTH|CREDENTIAL)[^\s=]*)=(\S+)/gi, (_, key, value) => {
+    return `${key}=${maskValue(value)}`;
+  });
+}
+function maskSensitiveData(data) {
+  if (data === null || data === void 0) return data;
+  if (typeof data === "string") return data;
+  if (Array.isArray(data)) return data.map(maskSensitiveData);
+  if (typeof data === "object") {
+    const result = {};
+    for (const [key, value] of Object.entries(data)) {
+      if (typeof value === "string" && SENSITIVE_RE.test(key)) {
+        result[key] = maskValue(value);
+      } else if (typeof value === "object" && value !== null) {
+        result[key] = maskSensitiveData(value);
+      } else {
+        result[key] = value;
+      }
+    }
+    return result;
+  }
+  return data;
+}
+
 // src/commands/diff.ts
 import chalk2 from "chalk";
 async function computeDiff(ctx, config) {
@@ -1106,6 +1137,21 @@ async function computeDiff(ctx, config) {
   }
   return result;
 }
+function maskDiffResult(diff) {
+  const masked = { apps: {}, services: diff.services, inSync: diff.inSync };
+  for (const [app, appDiff] of Object.entries(diff.apps)) {
+    const maskedAppDiff = {};
+    for (const [feature, d] of Object.entries(appDiff)) {
+      maskedAppDiff[feature] = {
+        status: d.status,
+        desired: maskSensitiveData(d.desired),
+        current: maskSensitiveData(d.current)
+      };
+    }
+    masked.apps[app] = maskedAppDiff;
+  }
+  return masked;
+}
 function formatSummary(diff) {
   const lines = [""];
   for (const [app, appDiff] of Object.entries(diff.apps)) {
@@ -1214,14 +1260,6 @@ function validate(filePath) {
   return { errors, warnings };
 }
 
-// src/core/mask.ts
-function maskSensitiveArgs(cmd) {
-  return cmd.replace(/([^\s=]*(?:TOKEN|SECRET|PASSWORD|KEY|AUTH|CREDENTIAL)[^\s=]*)=(\S+)/gi, (_, key, value) => {
-    if (value.length <= 4) return `${key}=****`;
-    return `${key}=****${value.slice(-4)}`;
-  });
-}
-
 // src/index.ts
 var require2 = createRequire(import.meta.url);
 var { version } = require2("../package.json");
@@ -1279,13 +1317,14 @@ ${result.errors.length} error(s), ${result.warnings.length} warning(s)`);
     console.log("Valid.");
   }
 });
-program.command("export").description("Export server state to dokku-compose.yml format").option("--app <app>", "Export only a specific app").option("-o, --output <path>", "Write to file instead of stdout").action(async (opts) => {
+program.command("export").description("Export server state to dokku-compose.yml format").option("--app <app>", "Export only a specific app").option("-o, --output <path>", "Write to file instead of stdout").option("--sensitive", "Show sensitive values (masked by default)").action(async (opts) => {
   const runner = makeRunner({});
   const ctx = createContext(runner);
   try {
-    const result = await runExport(ctx, {
+    const rawResult = await runExport(ctx, {
       appFilter: opts.app ? [opts.app] : void 0
     });
+    const result = opts.sensitive ? rawResult : maskSensitiveData(rawResult);
     const out = yaml3.dump(result, { lineWidth: 120 });
     if (opts.output) {
       fs3.writeFileSync(opts.output, out);
@@ -1297,15 +1336,16 @@ program.command("export").description("Export server state to dokku-compose.yml
     await ctx.close();
   }
 });
-program.command("diff").description("Show what is out of sync between config and server").option("-f, --file <path>", "Config file", "dokku-compose.yml").option("--verbose", "Show git-style +/- diff").action(async (opts) => {
+program.command("diff").description("Show what is out of sync between config and server").option("-f, --file <path>", "Config file", "dokku-compose.yml").option("--verbose", "Show git-style +/- diff").option("--sensitive", "Show sensitive values (masked by default)").action(async (opts) => {
   const desired = loadConfig(opts.file);
   const runner = makeRunner({});
   const ctx = createContext(runner);
   try {
-    const diff = await computeDiff(ctx, desired);
+    const rawDiff = await computeDiff(ctx, desired);
+    const diff = opts.sensitive ? rawDiff : maskDiffResult(rawDiff);
     const output = opts.verbose ? formatVerbose(diff) : formatSummary(diff);
     process.stdout.write(output);
-    process.exit(diff.inSync ? 0 : 1);
+    process.exit(rawDiff.inSync ? 0 : 1);
   } finally {
     await ctx.close();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dokku-compose",
-  "version": "0.6.9",
+  "version": "0.6.11",
   "description": "Docker Compose for Dokku — declare your entire server in a single YAML file.",
   "main": "dist/index.js",
   "exports": "./dist/index.js",