windmill-cli 1.666.0 → 1.667.0

package/esm/main.js

@@ -11618,21 +11618,40 @@ var require_dist = __commonJS((exports) => {
 import { readFile } from "node:fs/promises";
 async function yamlParseFile(path, options = {}) {
   try {
-    return import_yaml.parse(await readFile(path, "utf-8"), options);
+    return import_yaml.parse(await readFile(path, "utf-8"), {
+      ...options,
+      customTags: [...WINDMILL_CUSTOM_TAGS, ...options.customTags ?? []]
+    });
   } catch (e) {
     throw new Error(`Error parsing yaml ${path}`, { cause: e });
   }
 }
 function yamlParseContent(path, content, options = {}) {
   try {
-    return import_yaml.parse(content, options);
+    return import_yaml.parse(content, {
+      ...options,
+      customTags: [...WINDMILL_CUSTOM_TAGS, ...options.customTags ?? []]
+    });
   } catch (e) {
     throw new Error(`Error parsing yaml ${path}`, { cause: e });
   }
 }
-var import_yaml;
+var import_yaml, inlineTag, inlineFilesetTag, WINDMILL_CUSTOM_TAGS;
 var init_yaml = __esm(() => {
   import_yaml = __toESM(require_dist(), 1);
+  inlineTag = {
+    tag: "!inline",
+    resolve(value) {
+      return "!inline " + value;
+    }
+  };
+  inlineFilesetTag = {
+    tag: "!inline_fileset",
+    resolve(value) {
+      return "!inline_fileset " + value;
+    }
+  };
+  WINDMILL_CUSTOM_TAGS = [inlineTag, inlineFilesetTag];
 });
 
 // gen/core/ApiError.ts
@@ -11785,7 +11804,7 @@ var init_OpenAPI = __esm(() => {
     PASSWORD: undefined,
     TOKEN: getEnv2("WM_TOKEN"),
     USERNAME: undefined,
-    VERSION: "1.666.0",
+    VERSION: "1.667.0",
     WITH_CREDENTIALS: true,
     interceptors: {
       request: new Interceptors,
@@ -12344,6 +12363,7 @@ __export(exports_services_gen, {
   importQueuedJobs: () => importQueuedJobs,
   importInstallation: () => importInstallation,
   importCompletedJobs: () => importCompletedJobs,
+  impersonateServiceAccount: () => impersonateServiceAccount,
   globalWhoami: () => globalWhoami,
   globalUsersOverwrite: () => globalUsersOverwrite,
   globalUsersExport: () => globalUsersExport,
@@ -12521,6 +12541,7 @@ __export(exports_services_gen, {
   exportInstanceGroups: () => exportInstanceGroups,
   exportInstallation: () => exportInstallation,
   exportCompletedJobs: () => exportCompletedJobs,
+  exitImpersonation: () => exitImpersonation,
   existsWorkspace: () => existsWorkspace,
   existsWorkersWithTags: () => existsWorkersWithTags,
   existsWebsocketTrigger: () => existsWebsocketTrigger,
@@ -12635,6 +12656,7 @@ __export(exports_services_gen, {
   createToken: () => createToken,
   createTemplateScript: () => createTemplateScript,
   createSqsTrigger: () => createSqsTrigger,
+  createServiceAccount: () => createServiceAccount,
   createScript: () => createScript,
   createSchedule: () => createSchedule,
   createResourceType: () => createResourceType,
@@ -13374,6 +13396,36 @@ var backendVersion = () => {
     body: data2.requestBody,
     mediaType: "application/json"
   });
+}, createServiceAccount = (data2) => {
+  return request(OpenAPI, {
+    method: "POST",
+    url: "/w/{workspace}/workspaces/create_service_account",
+    path: {
+      workspace: data2.workspace
+    },
+    body: data2.requestBody,
+    mediaType: "application/json"
+  });
+}, impersonateServiceAccount = (data2) => {
+  return request(OpenAPI, {
+    method: "POST",
+    url: "/w/{workspace}/users/impersonate_service_account",
+    path: {
+      workspace: data2.workspace
+    },
+    body: data2.requestBody,
+    mediaType: "application/json"
+  });
+}, exitImpersonation = (data2) => {
+  return request(OpenAPI, {
+    method: "POST",
+    url: "/w/{workspace}/users/exit_impersonation",
+    path: {
+      workspace: data2.workspace
+    },
+    body: data2.requestBody,
+    mediaType: "application/json"
+  });
 }, deleteInvite = (data2) => {
   return request(OpenAPI, {
     method: "POST",
@@ -24449,6 +24501,12 @@ function isRawAppMetadataFile(p) {
 function isRawAppFolderMetadataFile(p) {
   return p.endsWith(getMetadataPathSuffix("raw_app", "yaml")) || p.endsWith(getMetadataPathSuffix("raw_app", "json"));
 }
+function isAppFolderMetadataFile(p) {
+  return p.endsWith(getMetadataPathSuffix("app", "yaml")) || p.endsWith(getMetadataPathSuffix("app", "json"));
+}
+function isFlowFolderMetadataFile(p) {
+  return p.endsWith(getMetadataPathSuffix("flow", "yaml")) || p.endsWith(getMetadataPathSuffix("flow", "json"));
+}
 function getModuleFolderSuffix() {
   return MODULE_SUFFIX;
 }
@@ -56161,12 +56219,16 @@ function getBranchSpecificTypes() {
   return {
     variable: ".variable.yaml",
     resource: ".resource.yaml",
+    schedule: ".schedule.yaml",
     ...Object.fromEntries(TRIGGER_TYPES.map((t) => [`${t}_trigger`, `.${t}_trigger.yaml`]))
   };
 }
 function isTriggerFile(path5) {
   return TRIGGER_TYPES.some((type) => path5.endsWith(`.${type}_trigger.yaml`));
 }
+function isScheduleFile(path5) {
+  return path5.endsWith(".schedule.yaml");
+}
 function getFileTypeSuffix(path5) {
   for (const [_, suffix] of Object.entries(getBranchSpecificTypes())) {
     if (path5.endsWith(suffix)) {
@@ -56180,7 +56242,7 @@ function getFileTypeSuffix(path5) {
   return null;
 }
 function buildYamlTypePattern() {
-  const basicTypes = ["variable", "resource"];
+  const basicTypes = ["variable", "resource", "schedule"];
   const triggerTypes = TRIGGER_TYPES.map((t) => `${t}_trigger`);
   return `((${basicTypes.join("|")})|(${triggerTypes.join("|")}))`;
 }
@@ -56212,6 +56274,9 @@ function getSpecificItemsForCurrentBranch(config, branchOverride) {
   if (commonItems?.triggers) {
     merged.triggers = [...commonItems.triggers];
   }
+  if (commonItems?.schedules) {
+    merged.schedules = [...commonItems.schedules];
+  }
   if (commonItems?.folders) {
     merged.folders = [...commonItems.folders];
   }
@@ -56227,6 +56292,9 @@ function getSpecificItemsForCurrentBranch(config, branchOverride) {
   if (branchItems?.triggers) {
     merged.triggers = [...merged.triggers || [], ...branchItems.triggers];
   }
+  if (branchItems?.schedules) {
+    merged.schedules = [...merged.schedules || [], ...branchItems.schedules];
+  }
   if (branchItems?.folders) {
     merged.folders = [...merged.folders || [], ...branchItems.folders];
   }
@@ -56251,6 +56319,9 @@ function isItemTypeConfigured(path5, specificItems) {
   if (isTriggerFile(path5)) {
     return specificItems.triggers !== undefined;
   }
+  if (isScheduleFile(path5)) {
+    return specificItems.schedules !== undefined;
+  }
   if (path5.endsWith("/folder.meta.yaml")) {
     return specificItems.folders !== undefined;
   }
@@ -56275,6 +56346,9 @@ function isSpecificItem(path5, specificItems) {
   if (isTriggerFile(path5)) {
     return specificItems.triggers ? matchesPatterns(path5, specificItems.triggers) : false;
   }
+  if (isScheduleFile(path5)) {
+    return specificItems.schedules ? matchesPatterns(path5, specificItems.schedules) : false;
+  }
   if (path5.endsWith("/folder.meta.yaml")) {
     if (specificItems.folders) {
       const folderPath = path5.slice(0, -"/folder.meta.yaml".length);
@@ -60557,6 +60631,10 @@ function getLanguageFromExtension(ext2, defaultTs = "bun") {
   }
   return;
 }
+function sanitizeForFilesystem(summary) {
+  const name = summary.toLowerCase().replaceAll(" ", "_").replace(/[/\\:*?"<>|\x00-\x1f\x7f]/g, "").replace(/_+/g, "_").replace(/^[._]+|[._]+$/g, "");
+  return WINDOWS_RESERVED.test(name) ? `_${name}` : name;
+}
 function newPathAssigner(defaultTs, options) {
   const resolvedOptions = typeof defaultTs === "object" ? defaultTs : { defaultTs, skipInlineScriptSuffix: options?.skipInlineScriptSuffix };
   const { defaultTs: tsRuntime, skipInlineScriptSuffix } = resolvedOptions;
@@ -60564,7 +60642,7 @@ function newPathAssigner(defaultTs, options) {
   const seen_names = new Set;
   function assignPath(summary, language) {
     let name;
-    name = summary?.toLowerCase()?.replaceAll(" ", "_") ?? "";
+    name = summary ? sanitizeForFilesystem(summary) : "";
     let original_name = name;
     if (name == "") {
       original_name = INLINE_SCRIPT_PREFIX;
@@ -60586,7 +60664,7 @@ function newRawAppPathAssigner(defaultTs) {
   const seen_names = new Set;
   function assignPath(summary, language) {
     let name;
-    name = summary?.toLowerCase()?.replaceAll(" ", "_") ?? "";
+    name = summary ? sanitizeForFilesystem(summary) : "";
     let original_name = name;
     if (name == "") {
       original_name = "runnable";
@@ -60602,7 +60680,7 @@ function newRawAppPathAssigner(defaultTs) {
   }
   return { assignPath };
 }
-var INLINE_SCRIPT_PREFIX = "inline_script", LANGUAGE_EXTENSIONS, EXTENSION_TO_LANGUAGE;
+var INLINE_SCRIPT_PREFIX = "inline_script", LANGUAGE_EXTENSIONS, EXTENSION_TO_LANGUAGE, WINDOWS_RESERVED;
 var init_path_assigner = __esm(() => {
   LANGUAGE_EXTENSIONS = {
     python3: "py",
@@ -60656,19 +60734,23 @@ var init_path_assigner = __esm(() => {
     rb: "ruby",
     ts: "bun"
   };
+  WINDOWS_RESERVED = /^(con|prn|aux|nul|com[0-9]|lpt[0-9])$/;
 });
 
 // windmill-utils-internal/src/inline-scripts/extractor.ts
 function extractRawscriptInline(id, summary, rawscript, mapping, separator, assigner) {
   const [basePath, ext2] = assigner.assignPath(summary ?? id, rawscript.language);
-  const path7 = mapping[id] ?? basePath + ext2;
+  const mappedPath = mapping[id];
+  const path7 = mappedPath ?? basePath + ext2;
   const language = rawscript.language;
   const content = rawscript.content;
   const r = [{ path: path7, content, language, is_lock: false }];
   rawscript.content = "!inline " + path7.replaceAll(separator, "/");
   const lock = rawscript.lock;
   if (lock && lock != "") {
-    const lockPath = basePath + "lock";
+    const dotIdx = mappedPath ? mappedPath.lastIndexOf(".") : -1;
+    const lockBasePath = mappedPath ? dotIdx > 0 ? mappedPath.substring(0, dotIdx + 1) : mappedPath + "." : basePath;
+    const lockPath = lockBasePath + "lock";
     rawscript.lock = "!inline " + lockPath.replaceAll(separator, "/");
     r.push({ path: lockPath, content: lock, language, is_lock: true });
   }
@@ -60703,6 +60785,43 @@ function extractInlineScripts(modules, mapping = {}, separator = "/", defaultTs,
     }
   });
 }
+function extractCurrentMapping(modules, mapping = {}, failureModule, preprocessorModule) {
+  if (failureModule) {
+    extractCurrentMapping([failureModule], mapping);
+  }
+  if (preprocessorModule) {
+    extractCurrentMapping([preprocessorModule], mapping);
+  }
+  if (!modules || !Array.isArray(modules)) {
+    return mapping;
+  }
+  modules.forEach((m) => {
+    if (!m?.value?.type) {
+      return;
+    }
+    if (m.value.type === "rawscript") {
+      if (m.value.content && m.value.content.startsWith("!inline ")) {
+        mapping[m.id] = m.value.content.trim().split(" ")[1];
+      }
+    } else if (m.value.type === "forloopflow" || m.value.type === "whileloopflow") {
+      extractCurrentMapping(m.value.modules, mapping);
+    } else if (m.value.type === "branchall") {
+      m.value.branches.forEach((b) => extractCurrentMapping(b.modules, mapping));
+    } else if (m.value.type === "branchone") {
+      m.value.branches.forEach((b) => extractCurrentMapping(b.modules, mapping));
+      extractCurrentMapping(m.value.default, mapping);
+    } else if (m.value.type === "aiagent") {
+      (m.value.tools ?? []).forEach((tool) => {
+        const toolValue = tool.value;
+        if (!toolValue || toolValue.tool_type !== "flowmodule" || toolValue.type !== "rawscript" || !toolValue.content || !toolValue.content.startsWith("!inline ")) {
+          return;
+        }
+        mapping[tool.id] = toolValue.content.trim().split(" ")[1];
+      });
+    }
+  });
+  return mapping;
+}
 var init_extractor = __esm(() => {
   init_path_assigner();
 });
@@ -61000,6 +61119,7 @@ async function generateFlowLockInternal(folder, dryRun, workspace, opts, justUpd
       info(`Recomputing locks of ${changedScripts.join(", ")} in ${folder}`);
     }
     const fileReader = async (path8) => await readFile7(folder + SEP7 + path8, "utf-8");
+    const currentMapping = extractCurrentMapping(flowValue.value.modules, {}, flowValue.value.failure_module, flowValue.value.preprocessor_module);
     const locksToRemove = tree && !legacyBehaviour ? Object.keys(hashes).filter((k) => {
       if (k === TOP_HASH)
         return false;
@@ -61018,12 +61138,12 @@ async function generateFlowLockInternal(folder, dryRun, workspace, opts, justUpd
     const lockAssigner = newPathAssigner(opts.defaultTs ?? "bun", {
       skipInlineScriptSuffix: getNonDottedPaths()
     });
-    const inlineScripts = extractInlineScripts(flowValue.value.modules, {}, SEP7, opts.defaultTs, lockAssigner);
+    const inlineScripts = extractInlineScripts(flowValue.value.modules, currentMapping, SEP7, opts.defaultTs, lockAssigner);
     if (flowValue.value.failure_module) {
-      inlineScripts.push(...extractInlineScripts([flowValue.value.failure_module], {}, SEP7, opts.defaultTs, lockAssigner));
+      inlineScripts.push(...extractInlineScripts([flowValue.value.failure_module], currentMapping, SEP7, opts.defaultTs, lockAssigner));
     }
     if (flowValue.value.preprocessor_module) {
-      inlineScripts.push(...extractInlineScripts([flowValue.value.preprocessor_module], {}, SEP7, opts.defaultTs, lockAssigner));
+      inlineScripts.push(...extractInlineScripts([flowValue.value.preprocessor_module], currentMapping, SEP7, opts.defaultTs, lockAssigner));
     }
     inlineScripts.forEach((s) => {
       writeIfChanged(process.cwd() + SEP7 + folder + SEP7 + s.path, s.content);
@@ -63070,16 +63190,60 @@ ${folderList}
                   });
                   break;
                 case "flow":
-                  await deleteFlowByPath({
-                    workspace: workspaceId,
-                    path: removeSuffix(target, getDeleteSuffix("flow", "json"))
-                  });
+                  if (isFlowFolderMetadataFile(target)) {
+                    await deleteFlowByPath({
+                      workspace: workspaceId,
+                      path: removeSuffix(target, getDeleteSuffix("flow", "json"))
+                    });
+                  } else {
+                    const flowFolder = extractFolderPath(target, "flow");
+                    let flowFolderExists = false;
+                    if (flowFolder) {
+                      try {
+                        await stat6(flowFolder);
+                        flowFolderExists = true;
+                      } catch {}
+                    }
+                    if (flowFolderExists) {
+                      await pushObj(workspaceId, target, undefined, undefined, opts.plainSecrets ?? false, alreadySynced, opts.message);
+                    } else {
+                      const remotePath = extractResourceName(target, "flow");
+                      if (remotePath) {
+                        await deleteFlowByPath({
+                          workspace: workspaceId,
+                          path: remotePath
+                        });
+                      }
+                    }
+                  }
                   break;
                 case "app":
-                  await deleteApp({
-                    workspace: workspaceId,
-                    path: removeSuffix(target, getDeleteSuffix("app", "json"))
-                  });
+                  if (isAppFolderMetadataFile(target)) {
+                    await deleteApp({
+                      workspace: workspaceId,
+                      path: removeSuffix(target, getDeleteSuffix("app", "json"))
+                    });
+                  } else {
+                    const appFolder = extractFolderPath(target, "app");
+                    let appFolderExists = false;
+                    if (appFolder) {
+                      try {
+                        await stat6(appFolder);
+                        appFolderExists = true;
+                      } catch {}
+                    }
+                    if (appFolderExists) {
+                      await pushObj(workspaceId, target, undefined, undefined, opts.plainSecrets ?? false, alreadySynced, opts.message);
+                    } else {
+                      const remotePath = extractResourceName(target, "app");
+                      if (remotePath) {
+                        await deleteApp({
+                          workspace: workspaceId,
+                          path: remotePath
+                        });
+                      }
+                    }
+                  }
                   break;
                 case "raw_app":
                   if (isRawAppFolderMetadataFile(target)) {
@@ -69982,9 +70146,15 @@ async function pushObj(workspace, p, befObj, newObj, plainSecrets, alreadySynced
   const typeEnding = getTypeStrFromPath(p);
   if (typeEnding === "app") {
     const appName = extractResourceName(p, "app");
+    if (!appName) {
+      throw new Error(`Could not extract app name from path: ${p}`);
+    }
     await pushApp(workspace, appName, buildFolderPath(appName, "app"), message);
   } else if (typeEnding === "raw_app") {
     const rawAppName = extractResourceName(p, "raw_app");
+    if (!rawAppName) {
+      throw new Error(`Could not extract raw app name from path: ${p}`);
+    }
     await pushRawApp(workspace, rawAppName, buildFolderPath(rawAppName, "raw_app"), message);
   } else if (typeEnding === "folder") {
     await pushFolder(workspace, p, befObj, newObj);
@@ -69992,6 +70162,9 @@ async function pushObj(workspace, p, befObj, newObj, plainSecrets, alreadySynced
     await pushVariable(workspace, p, befObj, newObj, plainSecrets);
   } else if (typeEnding === "flow") {
     const flowName = extractResourceName(p, "flow");
+    if (!flowName) {
+      throw new Error(`Could not extract flow name from path: ${p}`);
+    }
     await pushFlow(workspace, flowName, buildFolderPath(flowName, "flow"), message);
   } else if (typeEnding === "resource") {
     if (!alreadySynced3.includes(p)) {
@@ -70607,11 +70780,12 @@ async function generateLocks(opts, folder) {
     }
   }
 }
-function bootstrap2(opts, flowPath) {
+async function bootstrap2(opts, flowPath) {
   if (!validatePath(flowPath)) {
     return;
   }
-  const flowDirFullPath = `${flowPath}.flow`;
+  await loadNonDottedPathsSetting();
+  const flowDirFullPath = buildFolderPath(flowPath, "flow");
   mkdirSync4(flowDirFullPath, { recursive: false });
   const newFlowDefinition = defaultFlowDefinition();
   if (opts.summary !== undefined) {
@@ -70621,7 +70795,8 @@ function bootstrap2(opts, flowPath) {
     newFlowDefinition.description = opts.description;
   }
   const newFlowDefinitionYaml = import_yaml36.stringify(newFlowDefinition);
-  const flowYamlPath = `${flowDirFullPath}/flow.yaml`;
+  const metadataFile = getMetadataFileName("flow", "yaml");
+  const flowYamlPath = `${flowDirFullPath}/${metadataFile}`;
   writeFileSync5(flowYamlPath, newFlowDefinitionYaml, { flag: "wx", encoding: "utf-8" });
 }
 var import_yaml36, alreadySynced3, command21, flow_default;
@@ -70632,6 +70807,7 @@ var init_flow = __esm(async () => {
   init_log();
   init_yaml();
   init_services_gen();
+  init_resource_folders();
   await __promiseAll([
     init_types(),
     init_confirm(),
@@ -73560,7 +73736,6 @@ await __promiseAll([
   init_workspace(),
   init_resource_type()
 ]);
-var import_yaml40 = __toESM(require_dist(), 1);
 import { stat as stat16, writeFile as writeFile19, rm as rm4, mkdir as mkdir9 } from "node:fs/promises";
 
 // src/guidance/skills.ts
@@ -78555,6 +78730,13 @@ app related commands
   - \`--dry-run\` - Perform a dry run without making changes
   - \`--default-ts <runtime:string>\` - Default TypeScript runtime (bun or deno)
 
+### config
+
+Show all available wmill.yaml configuration options
+
+**Options:**
+- \`--json\` - Output as JSON for programmatic consumption
+
 ### dependencies
 
 workspace dependencies related commands
@@ -79950,6 +80132,406 @@ ${skillsReference}
 `;
 }
 
+// src/commands/init/template.ts
+var NON_SCHEMA_KEYS = new Set([
+  "name",
+  "default",
+  "section",
+  "sectionNote",
+  "commented",
+  "templateValue",
+  "example",
+  "inlineComment",
+  "groupNote"
+]);
+var SPECIFIC_ITEMS_SCHEMA = {
+  type: "object",
+  description: "Sync only specific items",
+  properties: {
+    variables: { type: "array", items: { type: "string" }, description: "Specific variable paths to sync" },
+    resources: { type: "array", items: { type: "string" }, description: "Specific resource paths to sync" },
+    triggers: { type: "array", items: { type: "string" }, description: "Specific trigger paths to sync" },
+    folders: { type: "array", items: { type: "string" }, description: "Specific folder paths to sync" },
+    settings: { type: "boolean", description: "Whether to sync settings" }
+  },
+  additionalProperties: false
+};
+var BRANCH_CONFIG_SCHEMA = {
+  type: "object",
+  properties: {
+    baseUrl: { type: "string", description: "Windmill instance URL for this branch" },
+    workspaceId: { type: "string", description: "Workspace ID to sync with for this branch" },
+    overrides: { type: "object", description: "Override any top-level sync option for this branch" },
+    promotionOverrides: { type: "object", description: "Overrides applied when using --promotion flag" },
+    specificItems: SPECIFIC_ITEMS_SCHEMA
+  },
+  additionalProperties: false
+};
+var CONFIG_REFERENCE = [
+  { name: "defaultTs", type: "string", enum: ["bun", "deno"], default: "bun", description: "Default TypeScript runtime for new scripts" },
+  {
+    name: "includes",
+    type: "array",
+    items: { type: "string" },
+    default: '["f/**"]',
+    description: "Glob patterns for files to include in sync",
+    templateValue: `
+  - "f/**"`
+  },
+  {
+    name: "extraIncludes",
+    type: "array",
+    items: { type: "string" },
+    default: "[]",
+    description: "Additional glob patterns merged with includes (useful in branch overrides)",
+    commented: true
+  },
+  { name: "excludes", type: "array", items: { type: "string" }, default: "[]", description: "Glob patterns for files to exclude from sync" },
+  {
+    name: "skipVariables",
+    type: "boolean",
+    default: "false",
+    description: "Skip syncing variables",
+    section: "What to sync",
+    sectionNote: '"skip" options default to false (synced), "include" options default to false (not synced)'
+  },
+  { name: "skipResources", type: "boolean", default: "false", description: "Skip syncing resources" },
+  { name: "skipResourceTypes", type: "boolean", default: "false", description: "Skip syncing resource types" },
+  {
+    name: "skipSecrets",
+    type: "boolean",
+    default: "true",
+    description: "Skip syncing secrets (true by default for security)",
+    inlineComment: "true by default — secrets are not synced for security"
+  },
+  { name: "skipScripts", type: "boolean", default: "false", description: "Skip syncing scripts" },
+  { name: "skipFlows", type: "boolean", default: "false", description: "Skip syncing flows" },
+  { name: "skipApps", type: "boolean", default: "false", description: "Skip syncing apps" },
+  { name: "skipFolders", type: "boolean", default: "false", description: "Skip syncing folders" },
+  { name: "skipWorkspaceDependencies", type: "boolean", default: "false", description: "Skip syncing workspace dependencies" },
+  {
+    name: "includeSchedules",
+    type: "boolean",
+    default: "false",
+    description: "Include schedules in sync",
+    commented: true,
+    templateValue: "true",
+    groupNote: "Uncomment to include these (excluded by default):"
+  },
+  {
+    name: "includeTriggers",
+    type: "boolean",
+    default: "false",
+    description: "Include triggers (http, websocket, kafka, etc.) in sync",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "includeUsers",
+    type: "boolean",
+    default: "false",
+    description: "Include workspace users in sync",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "includeGroups",
+    type: "boolean",
+    default: "false",
+    description: "Include workspace groups in sync",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "includeSettings",
+    type: "boolean",
+    default: "false",
+    description: "Include workspace settings in sync",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "includeKey",
+    type: "boolean",
+    default: "false",
+    description: "Include encryption key in sync",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "parallel",
+    type: "integer",
+    default: "(unset)",
+    description: "Number of parallel operations during sync",
+    section: "Sync behavior",
+    commented: true,
+    templateValue: "4"
+  },
+  {
+    name: "locksRequired",
+    type: "boolean",
+    default: "false",
+    description: "Require lock files for all scripts",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "lint",
+    type: "boolean",
+    default: "false",
+    description: "Run linting before push",
+    commented: true,
+    templateValue: "true"
+  },
+  {
+    name: "plainSecrets",
+    type: "boolean",
+    default: "false",
+    description: "Handle secrets as plain text (not recommended)",
+    commented: true
+  },
+  {
+    name: "message",
+    type: "string",
+    default: "(unset)",
+    description: "Default commit message for sync operations",
+    commented: true,
+    templateValue: '"my commit message"'
+  },
+  {
+    name: "promotion",
+    type: "string",
+    default: "(unset)",
+    description: "Branch name to use promotion overrides from during sync",
+    commented: true,
+    templateValue: "staging"
+  },
+  {
+    name: "skipBranchValidation",
+    type: "boolean",
+    default: "false",
+    description: "Skip validation that current git branch matches a configured branch",
+    commented: true
+  },
+  { name: "nonDottedPaths", type: "boolean", default: "true", description: "Use __flow/__app/__raw_app suffixes instead of .flow/.app/.raw_app" },
+  {
+    name: "codebases",
+    type: "array",
+    default: "[]",
+    description: "Codebase bundling configurations for shared libraries",
+    items: {
+      type: "object",
+      properties: {
+        relative_path: { type: "string", description: "Path to the codebase directory" },
+        includes: { type: "array", items: { type: "string" }, description: "Glob patterns for files to include in bundle" },
+        excludes: { type: "array", items: { type: "string" }, description: "Glob patterns for files to exclude from bundle" },
+        format: { type: "string", enum: ["cjs", "esm"], description: "Bundle output format" },
+        external: { type: "array", items: { type: "string" }, description: "Dependencies to leave unbundled (externals)" },
+        assets: { type: "array", items: { type: "object", properties: { from: { type: "string" }, to: { type: "string" } }, required: ["from", "to"] }, description: "Static files to copy into the bundle" },
+        customBundler: { type: "string", description: "Path to a custom bundler script (replaces esbuild)" },
+        inject: { type: "array", items: { type: "string" }, description: "Files to inject into every entry point" },
+        define: { type: "object", additionalProperties: { type: "string" }, description: "Compile-time constant definitions" },
+        banner: { type: "object", additionalProperties: { type: "string" }, description: "Text to prepend to output files by type" },
+        loader: { type: "object", additionalProperties: { type: "string" }, description: "esbuild loader overrides by extension" }
+      },
+      required: ["relative_path"],
+      additionalProperties: false
+    },
+    section: "Codebase bundling (shared libraries)",
+    sectionNote: `Bundle TypeScript/JavaScript codebases that scripts import from.
+Each entry is bundled and uploaded so scripts can import shared code.`,
+    example: [
+      "# codebases:",
+      "#   - relative_path: ./shared          # path to the codebase",
+      '#     includes: ["**/*.ts"]            # files to include in bundle',
+      '#     excludes: ["node_modules/**"]    # files to exclude',
+      '#     format: esm                      # bundle format: "cjs" or "esm"',
+      '#     external: ["pg", "axios"]        # dependencies to leave unbundled',
+      "#     assets:                          # static files to copy into bundle",
+      "#       - from: ./static",
+      "#         to: ./dist",
+      "#     # customBundler: ./build.ts      # custom bundler script (replaces esbuild)",
+      '#     # inject: ["./polyfills.ts"]     # files to inject into every entry point',
+      "#     # define:                        # compile-time constants",
+      `#     #   API_URL: '"https://api.example.com"'`,
+      "#     # banner:                        # text prepended to output files",
+      '#     #   js: "/* bundled by windmill */"',
+      "#     # loader:                        # esbuild loader overrides",
+      '#     #   ".png": "dataurl"'
+    ].join(`
+`)
+  },
+  {
+    name: "gitBranches",
+    type: "object",
+    default: "{}",
+    description: "Map git branches to workspaces and per-branch sync overrides",
+    properties: { commonSpecificItems: SPECIFIC_ITEMS_SCHEMA },
+    additionalProperties: BRANCH_CONFIG_SCHEMA,
+    section: "Git branch / environment bindings",
+    sectionNote: `Map git branches to Windmill workspaces and override settings per branch.
+Use "environments" as an alias if you prefer environment-based terminology.`,
+    templateValue: `
+  {{BRANCH}}:
+    overrides: {}`,
+    example: [
+      "{{BASEURL_LINE}}",
+      "{{WORKSPACE_ID_LINE}}",
+      "    # promotionOverrides:                  # overrides applied during --promotion",
+      "    #   skipSecrets: false",
+      "    # specificItems:                       # only sync these specific items",
+      '    #   variables: ["f/my_folder/my_var"]',
+      '    #   resources: ["f/my_folder/my_res"]',
+      '    #   triggers: ["f/my_folder/my_trigger"]',
+      '    #   folders: ["my_folder"]',
+      "    #   settings: true",
+      "",
+      "  # Example: staging branch bound to a different workspace",
+      "  # staging:",
+      "  #   baseUrl: https://staging.windmill.dev",
+      "  #   workspaceId: staging-workspace",
+      "  #   overrides:",
+      "  #     skipSecrets: false",
+      "  #     includeSchedules: true",
+      "",
+      "  # Items shared across ALL branches",
+      "  # commonSpecificItems:",
+      '  #   variables: ["f/shared/api_key"]',
+      '  #   resources: ["f/shared/db_conn"]',
+      '  #   folders: ["shared"]'
+    ].join(`
+`)
+  },
+  {
+    name: "environments",
+    type: "object",
+    default: "{}",
+    description: "Alias for gitBranches — use if you prefer environment-based terminology",
+    properties: { commonSpecificItems: SPECIFIC_ITEMS_SCHEMA },
+    additionalProperties: BRANCH_CONFIG_SCHEMA,
+    commented: true
+  }
+];
+function yamlKey(s) {
+  if (/^[a-zA-Z0-9_/.@-]+$/.test(s) && !/^(true|false|yes|no|on|off|null|~)$/i.test(s) && !/^\d+(\.\d+)?$/.test(s)) {
+    return s;
+  }
+  return `"${s.replace(/\\/g, "\\\\").replace(/"/g, "\\\"")}"`;
+}
+function generateCommentedTemplate(branchName, binding) {
+  const branch = yamlKey(branchName ?? "main");
+  const lines = [
+    "# yaml-language-server: $schema=wmill.schema.json",
+    "# wmill.yaml — Windmill CLI configuration",
+    '# Full reference: run "wmill config"',
+    ""
+  ];
+  for (const opt of CONFIG_REFERENCE) {
+    if (opt.section) {
+      const ruler = "-".repeat(Math.max(0, 65 - opt.section.length));
+      lines.push(`# --- ${opt.section} ${ruler}`);
+      if (opt.sectionNote) {
+        for (const noteLine of opt.sectionNote.split(`
+`)) {
+          lines.push(`# ${noteLine}`);
+        }
+      }
+      lines.push("");
+    }
+    if (opt.groupNote) {
+      lines.push(`# ${opt.groupNote}`);
+    }
+    const value = opt.templateValue ?? opt.default;
+    const resolvedValue = value.replace("{{BRANCH}}", branch);
+    if (opt.commented) {
+      lines.push(`# ${opt.description}`);
+      lines.push(`# ${opt.name}: ${resolvedValue}`);
+    } else {
+      lines.push(`# ${opt.description}`);
+      if (opt.inlineComment) {
+        const base = `${opt.name}: ${resolvedValue}`;
+        const pad = " ".repeat(Math.max(1, 32 - base.length));
+        lines.push(`${base}${pad}# ${opt.inlineComment}`);
+      } else {
+        lines.push(`${opt.name}: ${resolvedValue}`);
+      }
+    }
+    if (opt.example) {
+      let resolvedExample = opt.example.replace(/\{\{BRANCH\}\}/g, branch);
+      if (binding) {
+        resolvedExample = resolvedExample.replace("{{BASEURL_LINE}}", `    baseUrl: ${binding.baseUrl}`).replace("{{WORKSPACE_ID_LINE}}", `    workspaceId: ${binding.workspaceId}`);
+      } else {
+        resolvedExample = resolvedExample.replace("{{BASEURL_LINE}}", "    # baseUrl: https://app.windmill.dev    # Windmill instance URL for this branch").replace("{{WORKSPACE_ID_LINE}}", "    # workspaceId: my-workspace            # workspace to sync with");
+      }
+      for (const exLine of resolvedExample.split(`
+`)) {
+        lines.push(exLine);
+      }
+    }
+    lines.push("");
+  }
+  return lines.join(`
+`);
+}
+function expandSchema(prefix, schema, rows) {
+  if (schema.properties) {
+    for (const [key, prop] of Object.entries(schema.properties)) {
+      const name = prefix ? `${prefix}.${key}` : key;
+      rows.push({ name, description: prop.description ?? "", default: "" });
+      if (prop.properties && prop.type === "object") {
+        expandSchema(name, prop, rows);
+      }
+    }
+  }
+}
+function formatConfigReference() {
+  const nameWidth = 48;
+  const descWidth = 70;
+  const header = [
+    "OPTION".padEnd(nameWidth),
+    "DESCRIPTION".padEnd(descWidth),
+    "DEFAULT"
+  ].join("  ");
+  const separator = "-".repeat(header.length + 10);
+  const allRows = [];
+  for (const opt of CONFIG_REFERENCE) {
+    allRows.push({ name: opt.name, description: opt.description, default: opt.default });
+    if (opt.items?.properties) {
+      expandSchema(`${opt.name}[]`, opt.items, allRows);
+    }
+    if (opt.additionalProperties && typeof opt.additionalProperties === "object" && opt.additionalProperties.properties) {
+      expandSchema(`${opt.name}.<branch>`, opt.additionalProperties, allRows);
+    }
+    if (opt.properties) {
+      expandSchema(opt.name, opt, allRows);
+    }
+  }
+  const rows = allRows.map((r) => [r.name.padEnd(nameWidth), r.description.padEnd(descWidth), r.default].join("  "));
+  return [
+    "wmill.yaml — Configuration Reference",
+    "",
+    "Full documentation: https://www.windmill.dev/docs/advanced/cli",
+    "",
+    separator,
+    header,
+    separator,
+    ...rows,
+    separator,
+    "",
+    'Run "wmill init" to generate a wmill.yaml with commented examples.'
+  ].join(`
+`);
+}
+function formatConfigReferenceJson() {
+  const clean = CONFIG_REFERENCE.map((opt) => ({
+    name: opt.name,
+    type: opt.type,
+    default: opt.default,
+    description: opt.description
+  }));
+  return JSON.stringify(clean, null, 2);
+}
+
 // src/commands/init/init.ts
 function formatSchemaForMarkdown(schemaYaml, schemaName, filePattern) {
   return `## ${schemaName} (\`${filePattern}\`)
@@ -79964,36 +80546,22 @@ async function initAction(opts) {
   if (await stat16("wmill.yaml").catch(() => null)) {
     error(colors.red("wmill.yaml already exists"));
   } else {
-    const { DEFAULT_SYNC_OPTIONS: DEFAULT_SYNC_OPTIONS2 } = await init_conf().then(() => exports_conf);
-    const initialConfig = { ...DEFAULT_SYNC_OPTIONS2 };
     const { isGitRepository: isGitRepository2, getCurrentGitBranch: getCurrentGitBranch2 } = await Promise.resolve().then(() => (init_git(), exports_git));
+    let branchName;
+    let binding;
     if (isGitRepository2()) {
-      const currentBranch = getCurrentGitBranch2();
-      if (currentBranch) {
-        initialConfig.gitBranches = {
-          [currentBranch]: { overrides: {} }
-        };
-      } else {
-        initialConfig.gitBranches = {};
-      }
-    } else {
-      initialConfig.gitBranches = {};
+      branchName = getCurrentGitBranch2() ?? undefined;
     }
-    initialConfig.nonDottedPaths = true;
-    await writeFile19("wmill.yaml", import_yaml40.stringify(initialConfig), "utf-8");
-    info(colors.green("wmill.yaml created with default settings"));
-    await readLockfile();
-    if (isGitRepository2()) {
+    if (isGitRepository2() && branchName) {
       const activeWorkspace = await getActiveWorkspaceOrFallback(opts);
-      const currentBranch = getCurrentGitBranch2();
-      if (activeWorkspace && currentBranch) {
+      if (activeWorkspace) {
         const shouldBind = opts.bindProfile === true;
         const shouldPrompt = opts.bindProfile === undefined && !!process.stdin.isTTY && !opts.useDefault;
-        const shouldSkip = opts.bindProfile != true && (opts.useDefault || !!!process.stdin.isTTY);
+        const shouldSkip = opts.bindProfile != true && (opts.useDefault || !process.stdin.isTTY);
         if (!shouldSkip) {
           if (shouldBind || shouldPrompt) {
             info(colors.yellow(`
-Current Git branch: ${colors.bold(currentBranch)}`));
+Current Git branch: ${colors.bold(branchName)}`));
             info(colors.yellow(`Active workspace profile: ${colors.bold(activeWorkspace.name)}`));
             info(colors.yellow(`  ${activeWorkspace.workspaceId} on ${activeWorkspace.remote}`));
           }
@@ -80001,22 +80569,21 @@ Current Git branch: ${colors.bold(currentBranch)}`));
             message: "Bind workspace profile to current Git branch?",
             default: true
           })) {
-            const currentConfig = await init_conf().then(() => exports_conf).then((m) => m.readConfigFile());
-            if (!currentConfig.gitBranches) {
-              currentConfig.gitBranches = {};
-            }
-            if (!currentConfig.gitBranches[currentBranch]) {
-              currentConfig.gitBranches[currentBranch] = { overrides: {} };
-            }
-            info(`binding branch ${currentBranch} to workspace ${activeWorkspace.name} on ${activeWorkspace.remote}`);
-            currentConfig.gitBranches[currentBranch].baseUrl = activeWorkspace.remote;
-            currentConfig.gitBranches[currentBranch].workspaceId = activeWorkspace.workspaceId;
-            await writeFile19("wmill.yaml", import_yaml40.stringify(currentConfig), "utf-8");
-            info(colors.green(`✓ Bound branch '${currentBranch}' to workspace '${activeWorkspace.name}'`));
+            info(`binding branch ${branchName} to workspace ${activeWorkspace.name} on ${activeWorkspace.remote}`);
+            binding = {
+              baseUrl: activeWorkspace.remote,
+              workspaceId: activeWorkspace.workspaceId
+            };
           }
         }
       }
     }
+    await writeFile19("wmill.yaml", generateCommentedTemplate(branchName, binding), "utf-8");
+    info(colors.green("wmill.yaml created with default settings"));
+    if (binding) {
+      info(colors.green(`✓ Bound branch '${branchName}' to workspace`));
+    }
+    await readLockfile();
     if (!opts.useDefault) {
       try {
         const { requireLogin: requireLogin2 } = await init_auth().then(() => exports_auth);
@@ -80615,10 +81182,23 @@ ${await res.text()}`);
 var command30 = new Command().name("docs").description("Search Windmill documentation. Requires Enterprise Edition.").arguments("<query:string>").option("--json", "Output results as JSON.").action(docs);
 var docs_default = command30;
 
+// src/commands/config/config.ts
+init_mod3();
+init_log();
+async function configAction(opts) {
+  if (opts.json) {
+    console.log(formatConfigReferenceJson());
+  } else {
+    info(formatConfigReference());
+  }
+}
+var command31 = new Command().name("config").description("Show all available wmill.yaml configuration options").option("--json", "Output as JSON for programmatic consumption").action(configAction);
+var config_default = command31;
+
 // src/main.ts
 await init_context();
-var VERSION = "1.666.0";
-var command31 = new Command().name("wmill").action(() => info(`Welcome to Windmill CLI ${VERSION}. Use -h for help.`)).description("Windmill CLI").globalOption("--workspace <workspace:string>", "Specify the target workspace. This overrides the default workspace.").globalOption("--debug --verbose", "Show debug/verbose logs").globalOption("--show-diffs", "Show diff informations when syncing (may show sensitive informations)").globalOption("--token <token:string>", "Specify an API token. This will override any stored token.").globalOption("--base-url <baseUrl:string>", "Specify the base URL of the API. If used, --token and --workspace are required and no local remote/workspace already set will be used.").globalOption("--config-dir <configDir:string>", "Specify a custom config directory. Overrides WMILL_CONFIG_DIR environment variable and default ~/.config location.").env("HEADERS <headers:string>", `Specify headers to use for all requests. e.g: "HEADERS='h1: v1, h2: v2'"`).version(VERSION).versionOption(false).command("init", init_default).command("app", app_default).command("flow", flow_default).command("script", script_default).command("workspace", workspace_default).command("resource", resource_default).command("resource-type", resource_type_default).command("user", user_default).command("variable", variable_default).command("hub", hub_default).command("folder", folder_default).command("schedule", schedule_default).command("trigger", trigger_default).command("dev", dev_default2).command("sync", sync_default).command("lint", lint_default).command("gitsync-settings", gitsync_settings_default).command("instance", instance_default).command("worker-groups", worker_groups_default).command("workers", workers_default).command("queues", queues_default).command("dependencies", dependencies_default).command("jobs", jobs_default).command("generate-metadata", generate_metadata_default).command("docs", docs_default).command("version --version", "Show version information").action(async (opts) => {
+var VERSION = "1.667.0";
+var command32 = new Command().name("wmill").action(() => info(`Welcome to Windmill CLI ${VERSION}. Use -h for help.`)).description("Windmill CLI").globalOption("--workspace <workspace:string>", "Specify the target workspace. This overrides the default workspace.").globalOption("--debug --verbose", "Show debug/verbose logs").globalOption("--show-diffs", "Show diff informations when syncing (may show sensitive informations)").globalOption("--token <token:string>", "Specify an API token. This will override any stored token.").globalOption("--base-url <baseUrl:string>", "Specify the base URL of the API. If used, --token and --workspace are required and no local remote/workspace already set will be used.").globalOption("--config-dir <configDir:string>", "Specify a custom config directory. Overrides WMILL_CONFIG_DIR environment variable and default ~/.config location.").env("HEADERS <headers:string>", `Specify headers to use for all requests. e.g: "HEADERS='h1: v1, h2: v2'"`).version(VERSION).versionOption(false).command("init", init_default).command("app", app_default).command("flow", flow_default).command("script", script_default).command("workspace", workspace_default).command("resource", resource_default).command("resource-type", resource_type_default).command("user", user_default).command("variable", variable_default).command("hub", hub_default).command("folder", folder_default).command("schedule", schedule_default).command("trigger", trigger_default).command("dev", dev_default2).command("sync", sync_default).command("lint", lint_default).command("gitsync-settings", gitsync_settings_default).command("instance", instance_default).command("worker-groups", worker_groups_default).command("workers", workers_default).command("queues", queues_default).command("dependencies", dependencies_default).command("jobs", jobs_default).command("generate-metadata", generate_metadata_default).command("docs", docs_default).command("config", config_default).command("version --version", "Show version information").action(async (opts) => {
   console.log("CLI version: " + VERSION);
   try {
     const provider = new NpmProvider({ package: "windmill-cli" });
@@ -80648,20 +81228,20 @@ var command31 = new Command().name("wmill").action(() => info(`Welcome to Windmi
   error(e);
   info("Try running with sudo and otherwise check the result of the command: npm uninstall windmill-cli && npm install -g windmill-cli");
 })).command("completions", new Command().description("Generate shell completions.").command("bash", new Command().description("Generate bash completions.").action(() => {
-  process.stdout.write(generateShellCompletions(command31, "bash") + `
+  process.stdout.write(generateShellCompletions(command32, "bash") + `
 `);
 })).command("zsh", new Command().description("Generate zsh completions.").action(() => {
-  process.stdout.write(generateShellCompletions(command31, "zsh") + `
+  process.stdout.write(generateShellCompletions(command32, "zsh") + `
 `);
 })).command("fish", new Command().description("Generate fish completions.").action(() => {
-  process.stdout.write(generateShellCompletions(command31, "fish") + `
+  process.stdout.write(generateShellCompletions(command32, "fish") + `
 `);
 })));
 async function main2() {
   try {
     const args = process.argv.slice(2);
     if (args.length === 0) {
-      command31.showHelp();
+      command32.showHelp();
     }
     const LOG_LEVEL = args.includes("--verbose") || args.includes("--debug") ? "DEBUG" : "INFO";
     setShowDiffs(args.includes("--show-diffs"));
@@ -80671,7 +81251,7 @@ async function main2() {
     if (extraHeaders) {
       OpenAPI.HEADERS = extraHeaders;
     }
-    await command31.parse(args);
+    await command32.parse(args);
   } catch (e) {
     if (e && typeof e === "object" && "name" in e && e.name === "ApiError") {
       console.log("Server failed. " + e.statusText + ": " + e.body);
@@ -80696,7 +81276,7 @@ if (isMain()) {
     process.stdin.destroy();
   });
 }
-var main_default = command31;
+var main_default = command32;
 export {
   add as workspaceAdd,
   workspace_default as workspace,
@@ -80720,6 +81300,7 @@ export {
   docs_default as docs,
   dev_default2 as dev,
   main_default as default,
+  config_default as config,
   app_default as app,
   WM_FORK_PREFIX,
   VERSION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windmill-cli",
-  "version": "1.666.0",
+  "version": "1.667.0",
   "description": "CLI for Windmill",
   "license": "Apache 2.0",
   "type": "module",