@kntic/kntic 0.8.0 → 0.9.0

package/README.md

@@ -42,13 +42,13 @@ kntic usage
 Download and extract the KNTIC bootstrap template into the current directory. Sets up the `.kntic/` directory structure, `kntic.yml`, and `.kntic.env`.
 
 ```bash
-kntic init [--quick | --interactive | -i]
+kntic init [--quick | -q | --interactive | -i]
 ```
 
 | Option | Description |
 |--------|-------------|
-| `--quick` | **Default.** Non-interactive mode. Auto-detects `GIT_HOST` and `GIT_REPO_PATH` from the git origin remote (SSH and HTTPS). Extracts `GITLAB_TOKEN` from HTTPS credentials if available (`glpat-*` tokens). |
-| `--interactive`, `-i` | Walks through all `.kntic.env` values interactively, prompting for each variable. Auto-detected values are pre-filled as defaults. Skips `KNTIC_VERSION` and already-detected `GITLAB_TOKEN`. |
+| `--interactive`, `-i` | **Default.** Walks through all `.kntic.env` values interactively, prompting for each variable. Auto-detected values are pre-filled as defaults. Skips `KNTIC_VERSION` and already-detected `GITLAB_TOKEN`. |
+| `--quick`, `-q` | Non-interactive mode. Auto-detects `GIT_HOST` and `GIT_REPO_PATH` from the git origin remote (SSH and HTTPS). Extracts `GITLAB_TOKEN` from HTTPS credentials if available (`glpat-*` tokens). |
 
 **What it does:**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kntic/kntic",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "author": "Thomas Robak <contact@kntic.ai> (https://kntic.ai)",
   "description": "KNTIC CLI — bootstrap and manage KNTIC projects",
   "main": "src/index.js",

package/src/commands/init.js

@@ -273,10 +273,11 @@ function interactiveEnvSetup(envPath) {
 /**
  * Run preflight checks before downloading the bootstrap archive.
  * All checks are warnings only — they never throw or exit.
- * Returns an array of warning strings (empty if all checks pass).
+ * Returns { warnings: string[], composeProvider: string|null }.
  */
 function preflightChecks() {
   const warnings = [];
+  let composeProvider = null;
 
   // 1. Linux platform check
   if (process.platform !== "linux") {
@@ -285,11 +286,31 @@ function preflightChecks() {
     );
   }
 
-  // 2. docker binary check
+  // 2. Compose provider detection
+  let hasDocker = false;
+  let hasPodman = false;
   try {
     execSync("which docker", { stdio: "ignore" });
-  } catch {
-    warnings.push("⚠  docker not found — required for `kntic start`");
+    hasDocker = true;
+  } catch {}
+  if (!hasDocker) {
+    try {
+      execSync("which podman", { stdio: "ignore" });
+      hasPodman = true;
+    } catch {}
+  }
+
+  if (hasDocker) {
+    composeProvider = "docker compose";
+  } else if (hasPodman) {
+    composeProvider = "podman-compose";
+    try {
+      execSync("which podman-compose", { stdio: "ignore" });
+    } catch {
+      warnings.push("⚠  podman-compose not found — install it via `pip install podman-compose`");
+    }
+  } else {
+    warnings.push("⚠  No container runtime found (docker or podman) — required for `kntic start`");
   }
 
   // 3. screen binary check
@@ -303,12 +324,12 @@ function preflightChecks() {
     console.log(w);
   }
 
-  return warnings;
+  return { warnings, composeProvider };
 }
 
 async function init(options = {}) {
   // Run preflight checks before anything else
-  preflightChecks();
+  const { composeProvider } = preflightChecks();
 
   // Resolve current version from the artifact metadata file
   const artifactFilename = await fetchText(BOOTSTRAP_ARTIFACT_URL);
@@ -328,6 +349,11 @@ async function init(options = {}) {
   // Clean up
   fs.unlinkSync(tmpFile);
 
+  // Auto-fill compose provider
+  if (composeProvider) {
+    fillEnvValues('.kntic.env', { KNTIC_COMPOSE_PROVIDER: composeProvider });
+  }
+
   // Auto-detect git remote
   const gitInfo = parseGitRemote();
 

package/src/commands/init.test.js

@@ -47,7 +47,7 @@ describe("preflightChecks", () => {
 
   it("warns when platform is not linux", () => {
     Object.defineProperty(process, "platform", { value: "darwin", configurable: true });
-    const warnings = preflightChecks();
+    const { warnings } = preflightChecks();
     const platformWarning = warnings.find((w) => w.includes("Non-Linux detected"));
     assert.ok(platformWarning, "should warn about non-linux platform");
     assert.ok(platformWarning.includes("darwin"));
@@ -55,24 +55,76 @@ describe("preflightChecks", () => {
 
   it("does not warn about platform on linux", () => {
     Object.defineProperty(process, "platform", { value: "linux", configurable: true });
-    const warnings = preflightChecks();
+    const { warnings } = preflightChecks();
     const platformWarning = warnings.find((w) => w.includes("Non-Linux detected"));
     assert.equal(platformWarning, undefined, "should not warn on linux");
   });
 
-  it("warns when docker is not found", () => {
-    // We test by checking the function handles missing binaries.
-    // On the test system docker may or may not exist, so we check the structure.
-    const warnings = preflightChecks();
-    // Each warning should be a string
-    for (const w of warnings) {
+  it("returns correct structure with warnings and composeProvider", () => {
+    const result = preflightChecks();
+    assert.ok(Array.isArray(result.warnings), "warnings must be an array");
+    // composeProvider is either a string or null
+    assert.ok(
+      result.composeProvider === null || typeof result.composeProvider === "string",
+      "composeProvider must be string or null"
+    );
+    for (const w of result.warnings) {
       assert.equal(typeof w, "string");
     }
   });
 
+  it("returns composeProvider 'docker compose' when docker is found", () => {
+    // On the test system docker may or may not exist. We verify the shape.
+    const { composeProvider } = preflightChecks();
+    // If docker is on PATH, provider should be 'docker compose'
+    let hasDocker = false;
+    try {
+      execSync("which docker", { stdio: "ignore" });
+      hasDocker = true;
+    } catch {}
+    if (hasDocker) {
+      assert.equal(composeProvider, "docker compose");
+    }
+  });
+
+  it("returns composeProvider 'podman-compose' when only podman is found", () => {
+    // This test verifies the detection logic structurally.
+    // On most CI systems docker is present, so we just verify the return shape.
+    const { composeProvider } = preflightChecks();
+    // If neither docker nor podman, composeProvider is null
+    let hasDocker = false;
+    let hasPodman = false;
+    try { execSync("which docker", { stdio: "ignore" }); hasDocker = true; } catch {}
+    if (!hasDocker) {
+      try { execSync("which podman", { stdio: "ignore" }); hasPodman = true; } catch {}
+    }
+    if (!hasDocker && hasPodman) {
+      assert.equal(composeProvider, "podman-compose");
+    }
+    if (!hasDocker && !hasPodman) {
+      assert.equal(composeProvider, null);
+    }
+  });
+
+  it("warns when neither docker nor podman found", () => {
+    // We verify the warning message format if it appears.
+    const { warnings, composeProvider } = preflightChecks();
+    let hasDocker = false;
+    let hasPodman = false;
+    try { execSync("which docker", { stdio: "ignore" }); hasDocker = true; } catch {}
+    if (!hasDocker) {
+      try { execSync("which podman", { stdio: "ignore" }); hasPodman = true; } catch {}
+    }
+    if (!hasDocker && !hasPodman) {
+      assert.equal(composeProvider, null);
+      const runtimeWarning = warnings.find((w) => w.includes("No container runtime found"));
+      assert.ok(runtimeWarning, "should warn about missing container runtime");
+    }
+  });
+
   it("each warning is independent (all checks run)", () => {
     Object.defineProperty(process, "platform", { value: "win32", configurable: true });
-    const warnings = preflightChecks();
+    const { warnings } = preflightChecks();
     // Platform warning must be present regardless of binary check results
     const platformWarning = warnings.find((w) => w.includes("Non-Linux detected"));
     assert.ok(platformWarning, "platform warning must be present");
@@ -83,7 +135,7 @@ describe("preflightChecks", () => {
 
   it("prints warnings to console.log", () => {
     Object.defineProperty(process, "platform", { value: "freebsd", configurable: true });
-    const warnings = preflightChecks();
+    const { warnings } = preflightChecks();
     // At least the platform warning should be logged
     const platformLog = logMessages.find((m) => m.includes("Non-Linux detected"));
     assert.ok(platformLog, "platform warning must be printed via console.log");

package/src/commands/start.js

@@ -3,6 +3,7 @@
 const { execSync } = require("child_process");
 const { readFileSync } = require("fs");
 const { basename } = require("path");
+const { getComposeProvider } = require("./utils");
 
 function isScreenAvailable() {
   try {
@@ -31,7 +32,8 @@ function getScreenName() {
 }
 
 function start(options = {}) {
-  const composeCmd = "docker compose -f kntic.yml --env-file .kntic.env up --build";
+  const provider = getComposeProvider();
+  const composeCmd = `${provider} -f kntic.yml --env-file .kntic.env up --build`;
   const useScreen = !!options.screen;
 
   if (useScreen && isScreenAvailable() && !isInsideScreen()) {

package/src/commands/start.test.js

@@ -57,6 +57,38 @@ describe("start — getScreenName resolution", () => {
   });
 });
 
+describe("start — compose provider from .kntic.env", () => {
+  let tmpDir, origCwd;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "kntic-start-compose-"));
+    origCwd = process.cwd();
+    process.chdir(tmpDir);
+  });
+
+  afterEach(() => {
+    process.chdir(origCwd);
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  it("reads KNTIC_COMPOSE_PROVIDER from .kntic.env", () => {
+    fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "KNTIC_COMPOSE_PROVIDER=podman-compose\nUID=1000\n");
+    const { getComposeProvider } = require("./utils");
+    assert.equal(getComposeProvider(), "podman-compose");
+  });
+
+  it("defaults to 'docker compose' when KNTIC_COMPOSE_PROVIDER is missing", () => {
+    fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "UID=1000\nGID=1000\n");
+    const { getComposeProvider } = require("./utils");
+    assert.equal(getComposeProvider(), "docker compose");
+  });
+
+  it("defaults to 'docker compose' when .kntic.env does not exist", () => {
+    const { getComposeProvider } = require("./utils");
+    assert.equal(getComposeProvider(), "docker compose");
+  });
+});
+
 describe("start — isInsideScreen detection", () => {
   let origSTY;
 

package/src/commands/stop.js

@@ -1,9 +1,11 @@
 "use strict";
 
 const { execSync } = require("child_process");
+const { getComposeProvider } = require("./utils");
 
 function stop() {
-  const composeCmd = "docker compose -f kntic.yml --env-file .kntic.env stop";
+  const provider = getComposeProvider();
+  const composeCmd = `${provider} -f kntic.yml --env-file .kntic.env stop`;
   console.log("Stopping KNTIC services…");
   execSync(composeCmd, { stdio: "inherit" });
 }

package/src/commands/stop.test.js

@@ -1,8 +1,10 @@
 "use strict";
 
-const { describe, it } = require("node:test");
+const { describe, it, beforeEach, afterEach } = require("node:test");
 const assert = require("node:assert/strict");
 const fs = require("fs");
+const path = require("path");
+const os = require("os");
 
 describe("stop — module structure", () => {
   it("exports a function", () => {
@@ -10,8 +12,41 @@ describe("stop — module structure", () => {
     assert.equal(typeof stop, "function");
   });
 
-  it("source contains the correct docker compose stop command", () => {
+  it("source uses getComposeProvider for compose command", () => {
     const src = fs.readFileSync(require.resolve("./stop"), "utf8");
-    assert.ok(src.includes("docker compose -f kntic.yml --env-file .kntic.env stop"));
+    assert.ok(src.includes("getComposeProvider"), "should use getComposeProvider helper");
+    assert.ok(src.includes("-f kntic.yml --env-file .kntic.env stop"), "should include compose flags");
+  });
+});
+
+describe("stop — compose provider from .kntic.env", () => {
+  let tmpDir, origCwd;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "kntic-stop-compose-"));
+    origCwd = process.cwd();
+    process.chdir(tmpDir);
+  });
+
+  afterEach(() => {
+    process.chdir(origCwd);
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  it("reads KNTIC_COMPOSE_PROVIDER from .kntic.env", () => {
+    fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "KNTIC_COMPOSE_PROVIDER=podman-compose\nUID=1000\n");
+    const { getComposeProvider } = require("./utils");
+    assert.equal(getComposeProvider(), "podman-compose");
+  });
+
+  it("defaults to 'docker compose' when KNTIC_COMPOSE_PROVIDER is missing", () => {
+    fs.writeFileSync(path.join(tmpDir, ".kntic.env"), "UID=1000\nGID=1000\n");
+    const { getComposeProvider } = require("./utils");
+    assert.equal(getComposeProvider(), "docker compose");
+  });
+
+  it("defaults to 'docker compose' when .kntic.env does not exist", () => {
+    const { getComposeProvider } = require("./utils");
+    assert.equal(getComposeProvider(), "docker compose");
   });
 });

package/src/commands/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+
+const fs = require("fs");
+
+/**
+ * Read KNTIC_COMPOSE_PROVIDER from .kntic.env.
+ * Returns the value or 'docker compose' as fallback.
+ */
+function getComposeProvider() {
+  try {
+    const content = fs.readFileSync(".kntic.env", "utf8");
+    const match = content.match(/^KNTIC_COMPOSE_PROVIDER=(.+)$/m);
+    if (match && match[1].trim()) {
+      return match[1].trim();
+    }
+  } catch {
+    // .kntic.env not found or unreadable — fall through
+  }
+  return "docker compose";
+}
+
+module.exports = { getComposeProvider };