dockup-cli 1.3.2 → 1.4.0

package/dist/commands/config.js

@@ -0,0 +1,149 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target2, all) => {
+  for (var name in all)
+    __defProp(target2, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target2) => (target2 = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target2, "default", { value: mod, enumerable: true }) : target2,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var config_exports = {};
+__export(config_exports, {
+  plan: () => plan,
+  up: () => up
+});
+module.exports = __toCommonJS(config_exports);
+var import_chalk = __toESM(require("chalk"));
+var fs = __toESM(require("fs"));
+var path = __toESM(require("path"));
+var import_js_yaml = __toESM(require("js-yaml"));
+var import_config = require("../lib/config");
+var import_flags = require("../lib/flags");
+var import_output = require("../lib/output");
+var import_target = require("../lib/target");
+var import_api = require("../lib/api");
+function applyJson(opts) {
+  (0, import_flags.setJson)(!!opts?.json);
+}
+function requireAuth() {
+  if (!(0, import_config.isLoggedIn)()) (0, import_output.fail)("Not logged in. Run `dockup login` first.", { code: "not_logged_in" });
+}
+function target(arg) {
+  try {
+    return (0, import_target.resolveTarget)(arg);
+  } catch (e) {
+    return (0, import_output.fail)(e.message, { code: "no_target" });
+  }
+}
+const SECRETY = /(secret|token|password|passwd|api[_-]?key|private[_-]?key|_pat\b|credential)/i;
+function loadManifest(file) {
+  const p = path.resolve(process.cwd(), file || "dockup.yaml");
+  if (!fs.existsSync(p)) {
+    return (0, import_output.fail)(`No manifest at ${p}. Create a dockup.yaml or pass -f <path>.`, { code: "no_manifest" });
+  }
+  let parsed;
+  try {
+    parsed = import_js_yaml.default.load(fs.readFileSync(p, "utf8"));
+  } catch (e) {
+    return (0, import_output.fail)(`Invalid YAML: ${e.message}`, { code: "bad_yaml" });
+  }
+  const manifest = parsed?.service ? parsed : { service: parsed };
+  const env = manifest.service?.env || {};
+  const suspicious = Object.keys(env).filter((k) => SECRETY.test(k));
+  if (suspicious.length && !(0, import_flags.isJson)()) {
+    console.log(import_chalk.default.yellow(`\u26A0 Possible secret(s) inlined in dockup.yaml: ${suspicious.join(", ")}`));
+    console.log(import_chalk.default.dim("  Secrets should be set in the dashboard; yaml env are stored as non-secret.\n"));
+  }
+  return manifest;
+}
+const actionColor = (a) => a === "create" ? import_chalk.default.green : a === "update" ? import_chalk.default.yellow : a === "delete" ? import_chalk.default.red : a === "skip" ? import_chalk.default.gray : import_chalk.default.dim;
+const sign = (a) => a === "create" ? "+" : a === "update" ? "~" : a === "delete" ? "-" : a === "skip" ? "!" : "=";
+function printChanges(changes) {
+  if (!changes.length) {
+    console.log(import_chalk.default.dim("  (no changes)"));
+    return;
+  }
+  for (const c of changes) {
+    const col = actionColor(c.action);
+    const from = c.from === void 0 ? "" : typeof c.from === "object" ? JSON.stringify(c.from) : String(c.from);
+    const to = c.to === void 0 ? "" : typeof c.to === "object" ? JSON.stringify(c.to) : String(c.to);
+    const arrow = c.action === "update" ? `${import_chalk.default.dim(from)} \u2192 ${to}` : c.action === "delete" ? import_chalk.default.dim(from) : to;
+    const reason = c.reason ? import_chalk.default.dim(`  (${c.reason})`) : "";
+    console.log(`  ${col(sign(c.action))} ${c.field}  ${arrow}${reason}`);
+  }
+}
+async function plan(arg, opts) {
+  applyJson(opts);
+  requireAuth();
+  const t = target(arg);
+  const manifest = loadManifest(opts?.file);
+  try {
+    const res = await import_api.api.planConfig(t.projectSlug, t.serviceSlug, manifest);
+    const effective = res.changes.filter((c) => c.action !== "noop");
+    (0, import_output.emit)({ target: res.target, changes: res.changes }, () => {
+      console.log(import_chalk.default.cyan(`
+  Plan \u2014 ${res.target}
+`));
+      printChanges(effective.length ? effective : []);
+      if (!effective.length) console.log(import_chalk.default.green("  \u2713 up to date"));
+      console.log();
+    });
+  } catch (e) {
+    (0, import_output.fail)(e.message);
+  }
+}
+async function up(arg, opts) {
+  applyJson(opts);
+  requireAuth();
+  const t = target(arg);
+  const manifest = loadManifest(opts?.file);
+  try {
+    const res = await import_api.api.applyConfig(t.projectSlug, t.serviceSlug, {
+      manifest,
+      prune: !!opts?.prune,
+      deploy: !!opts?.deploy,
+      registryToken: opts?.registryToken
+    });
+    (0, import_output.ok)({ target: res.target, applied: res.applied, skipped: res.skipped, deploymentId: res.deploymentId || null, nextStep: res.nextStep }, () => {
+      console.log(import_chalk.default.cyan(`
+  Applied \u2014 ${res.target}
+`));
+      printChanges(res.applied || []);
+      if ((res.skipped || []).length) {
+        console.log(import_chalk.default.dim("\n  Skipped:"));
+        printChanges(res.skipped);
+      }
+      if (res.deploymentId) console.log(import_chalk.default.green(`
+  \u2713 deploy triggered (${res.deploymentId})`));
+      else if (res.nextStep) console.log(import_chalk.default.dim(`
+  ${res.nextStep}`));
+      console.log();
+    });
+  } catch (e) {
+    (0, import_output.fail)(e.message);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  plan,
+  up
+});

package/dist/index.js

@@ -32,8 +32,9 @@ var import_agent = require("./commands/agent");
 var import_workspace = require("./commands/workspace");
 var import_database = require("./commands/database");
 var import_remote = require("./commands/remote");
+var import_config = require("./commands/config");
 const program = new import_commander.Command();
-program.name("dockup").description("Dockup CLI - Deploy from your terminal").version("1.3.2");
+program.name("dockup").description("Dockup CLI - Deploy from your terminal").version("1.4.0");
 program.command("login").description("Authenticate with Dockup").option("-t, --token <token>", "Use API token directly").action(import_auth.login);
 program.command("logout").description("Log out from Dockup").action(import_auth.logout);
 program.command("whoami").description("Show current logged in user").action(import_auth.whoami);
@@ -55,6 +56,8 @@ registryCmd.command("set [project/service]").description("Set registry credentia
 registryCmd.command("clear [project/service]").description("Remove registry credentials").option("-j, --json", "Machine-readable JSON output").action(import_agent.registryClear);
 const resourcesCmd = program.command("resources [project/target]").alias("res").description("View reserved CPU/RAM (use `resources set` to change; --db for databases)").option("--db", "Target a database instead of a service").option("-j, --json", "Machine-readable JSON output").action(import_agent.resourcesView);
 resourcesCmd.command("set [project/target]").description("Set reserved CPU/RAM \u2014 PRO (max 24 vCPU / 24576 MB)").option("--cpu <vcpu>", "vCPU to reserve, e.g. 2").option("--memory <mb>", "RAM in MB to reserve, e.g. 4096").option("--db", "Target a database instead of a service").option("-j, --json", "Machine-readable JSON output").action(import_agent.resourcesSet);
+program.command("plan [project/service]").description("Diff dockup.yaml against the live service (read-only)").option("-f, --file <path>", "Path to the manifest (default ./dockup.yaml)").option("-j, --json", "Machine-readable JSON output").action(import_config.plan);
+program.command("up [project/service]").description("Apply dockup.yaml to the service (config as code)").option("-f, --file <path>", "Path to the manifest (default ./dockup.yaml)").option("--prune", "Delete env/domains not in the manifest (never secrets/services)").option("--deploy", "Trigger a deploy after applying").option("--registry-token <token>", "Registry token for registry.url/username in the manifest").option("-y, --yes", "Skip confirmation").option("-j, --json", "Machine-readable JSON output").action(import_config.up);
 program.command("deploy [project/service]").description("Trigger a deployment (no git push; use `push` for git+deploy)").option("-b, --branch <branch>", "Branch to deploy").option("-j, --json", "Machine-readable JSON output").action(import_agent.deployTrigger);
 program.command("open").description("Open service in browser").option("-d, --dashboard", "Open dashboard instead of live URL").action(import_open.open);
 const workspaceCmd = program.command("workspace").alias("ws").description("Manage workspaces");

package/dist/lib/api.js

@@ -285,6 +285,16 @@ class ApiClient {
   async runTask(taskId) {
     return this.post(`/remote/tasks/${taskId}/run`);
   }
+  // ==================== CONFIG-AS-CODE (dockup.yaml) ====================
+  async planConfig(projectSlug, serviceSlug, manifest) {
+    return this.post(`/projects/${projectSlug}/services/${serviceSlug}/plan`, { manifest });
+  }
+  async applyConfig(projectSlug, serviceSlug, body) {
+    return this.post(`/projects/${projectSlug}/services/${serviceSlug}/apply`, body);
+  }
+  async getConfigStatus(projectSlug, serviceSlug) {
+    return this.get(`/projects/${projectSlug}/services/${serviceSlug}/config-status`);
+  }
 }
 const api = new ApiClient();
 // Annotate the CommonJS export names for ESM import in node:

package/dockupcli.md

@@ -190,6 +190,49 @@ dockup server run <taskId> --json
 - `run` stops at the first non-zero exit and returns the combined output.
 - Manage the same servers/tasks visually in the dashboard → **Servers**.
 
+### Config as code — `dockup.yaml` (GitOps)
+
+Declare a service's config in a `dockup.yaml` at the repo root. It becomes the
+source of truth — apply it from the CLI, or it auto-applies on every deploy.
+
+```yaml
+# dockup.yaml
+service:
+  branch: main
+  port: 3000
+  dockerfile: Dockerfile
+  build: npm run build
+  start: npm start
+  resources:            # PRO; clamped to 0.5–24 vCPU / 512–24576 MB
+    cpu: 2
+    memory: 4096
+  env:                  # plain values only — NEVER put secrets here
+    NODE_ENV: production
+    API_URL: https://api.myapp.com
+  registry:             # token passed via --registry-token, not in yaml
+    url: ghcr.io
+    username: my-org
+  domains:
+    - api.myapp.com
+    - { domain: admin.myapp.com, port: 4000 }
+```
+
+```bash
+dockup plan my-project/my-api            # diff yaml vs live (read-only)
+dockup up my-project/my-api              # apply
+dockup up --deploy                       # apply + trigger a deploy
+dockup up --prune                        # also delete env/domains absent from yaml
+dockup up --registry-token "$GHCR_PAT"   # supply the registry token
+dockup plan -f dockup.staging.yaml ...   # use a different file
+# plan/up output (--json): { changes:[{aspect,field,from,to,action}], applied, skipped, deploymentId }
+```
+
+Safety guarantees:
+- **Never deletes services, databases or volumes** — only settings/resources/env/domains.
+- **Additive by default**: env/domains not in the yaml are left alone; `--prune` deletes them (never secrets).
+- **Secrets never live in yaml**: existing secret env vars are never overwritten or pruned.
+- **Auto-apply on deploy** is additive only (never prunes) and never blocks a deploy if the yaml is invalid.
+
 ---
 
 ## Agent recipes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dockup-cli",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Dockup CLI - deploy, env, logs, registry & more from your terminal (agent-friendly --json)",
   "main": "dist/index.js",
   "bin": {
@@ -26,12 +26,14 @@
     "commander": "^11.1.0",
     "conf": "^10.2.0",
     "inquirer": "^8.2.6",
+    "js-yaml": "^4.2.0",
     "node-fetch": "^2.7.0",
     "open": "^8.4.2",
     "ora": "^5.4.1"
   },
   "devDependencies": {
     "@types/inquirer": "^8.2.10",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^20.10.0",
     "@types/node-fetch": "^2.6.13",
     "ts-node": "^10.9.2",