dataiku-sdk 3.3.0 → 3.5.0

package/dist/src/cli/commands/plugin.js

@@ -3,6 +3,7 @@ import { validatedPluginGitUrl, validatePluginDestinationPath, validatePluginId,
 import { num, readStdinText, } from "../coerce.js";
 import { executionMode, } from "../flags.js";
 import { planResult, } from "../output.js";
+import { commandUsage, withUsage, } from "../syntax.js";
 import { requireArgs, requireNoArgs, UsageError, } from "../usage.js";
 const PLUGIN_EXIT_CODES = { usage: 1, error: 2, transient: 3, };
 /** Plan-time endpoint helpers. Paths are validated, then encoded per segment. */
@@ -63,39 +64,38 @@ function optionalStringFlag(flags, name) {
     }
     return value.trim();
 }
-const LIST_USAGE = "dss plugin list";
-const INSTALL_ZIP_USAGE = "dss plugin install-from-zip --file PATH [--dry-run] [--plan]";
-const INSTALL_STORE_USAGE = "dss plugin install-from-store <pluginId> [--dry-run] [--plan]";
-const INSTALL_GIT_USAGE = "dss plugin install-from-git --repository URL [--checkout REF] [--path-in-repository PATH] [--dry-run] [--plan]";
-const DOWNLOAD_USAGE = "dss plugin download <pluginId> --output PATH";
-const UPDATE_ZIP_USAGE = "dss plugin update-from-zip <pluginId> --file PATH [--dry-run] [--plan]";
-const UPDATE_STORE_USAGE = "dss plugin update-from-store <pluginId> [--dry-run] [--plan]";
-const UPDATE_GIT_USAGE = "dss plugin update-from-git <pluginId> --repository URL [--checkout REF] [--path-in-repository PATH] [--dry-run] [--plan]";
-const SETTINGS_GET_USAGE = "dss plugin settings-get <pluginId> [--project-key KEY]";
-const SETTINGS_SET_USAGE = "dss plugin settings-set <pluginId> (--content JSON|--file PATH|--stdin) [--project-key KEY] [--dry-run] [--plan]";
-const CODE_ENV_CREATE_USAGE = "dss plugin code-env-create <pluginId> [--conda] [--python-interpreter PY] [--wait] [--timeout MS] [--poll-interval MS] [--dry-run] [--plan]";
-const CODE_ENV_UPDATE_USAGE = "dss plugin code-env-update <pluginId> [--wait] [--timeout MS] [--poll-interval MS] [--dry-run] [--plan]";
-const MOVE_TO_DEV_USAGE = "dss plugin move-to-dev <pluginId> [--dry-run] [--plan]";
-const USAGES_USAGE = "dss plugin usages <pluginId> [--project-key KEY]";
-const DELETE_USAGE = "dss plugin delete <pluginId> [--force] [--dry-run] [--plan]";
-const CREATE_DEV_USAGE = "dss plugin create-dev <pluginId> --creation-mode EMPTY|GIT_CLONE|GIT_EXPORT [--repository URL] [--checkout REF] [--path-in-repository PATH] [--dry-run] [--plan]";
-const GET_GIT_REMOTE_USAGE = "dss plugin get-git-remote <pluginId>";
-const SET_GIT_REMOTE_USAGE = "dss plugin set-git-remote <pluginId> --repository URL [--dry-run] [--plan]";
-const DELETE_GIT_REMOTE_USAGE = "dss plugin delete-git-remote <pluginId> [--dry-run] [--plan]";
-const GIT_BRANCHES_USAGE = "dss plugin git-branches <pluginId>";
-const PUSH_USAGE = "dss plugin push <pluginId> [--dry-run] [--plan]";
-const PULL_USAGE = "dss plugin pull <pluginId> [--dry-run] [--plan]";
-const FETCH_USAGE = "dss plugin fetch <pluginId> [--dry-run] [--plan]";
-const RESET_LOCAL_USAGE = "dss plugin reset-local <pluginId> [--dry-run] [--plan]";
-const RESET_REMOTE_USAGE = "dss plugin reset-remote <pluginId> [--dry-run] [--plan]";
-const CONTENTS_LIST_USAGE = "dss plugin contents-list <pluginId>";
-const CONTENTS_GET_USAGE = "dss plugin contents-get <pluginId> <path> [--output PATH]";
-const CONTENTS_PUT_USAGE = "dss plugin contents-put <pluginId> <path> (--content TEXT|--file PATH|--stdin) [--dry-run] [--plan]";
-const CONTENTS_DELETE_USAGE = "dss plugin contents-delete <pluginId> <path> [--dry-run] [--plan]";
-const DETAILS_USAGE = "dss plugin details <pluginId> <path>";
-const FOLDER_ADD_USAGE = "dss plugin folder-add <pluginId> <path> [--dry-run] [--plan]";
-const RENAME_USAGE = "dss plugin rename <pluginId> <path> <new-name> [--dry-run] [--plan]";
-const MOVE_USAGE = "dss plugin move <pluginId> <path> <destination-folder> [--dry-run] [--plan]";
+const INSTALL_ZIP_USAGE = commandUsage("plugin", "install-from-zip");
+const INSTALL_STORE_USAGE = commandUsage("plugin", "install-from-store");
+const INSTALL_GIT_USAGE = commandUsage("plugin", "install-from-git");
+const DOWNLOAD_USAGE = commandUsage("plugin", "download");
+const UPDATE_ZIP_USAGE = commandUsage("plugin", "update-from-zip");
+const UPDATE_STORE_USAGE = commandUsage("plugin", "update-from-store");
+const UPDATE_GIT_USAGE = commandUsage("plugin", "update-from-git");
+const SETTINGS_GET_USAGE = commandUsage("plugin", "settings-get");
+const SETTINGS_SET_USAGE = commandUsage("plugin", "settings-set");
+const CODE_ENV_CREATE_USAGE = commandUsage("plugin", "code-env-create");
+const CODE_ENV_UPDATE_USAGE = commandUsage("plugin", "code-env-update");
+const MOVE_TO_DEV_USAGE = commandUsage("plugin", "move-to-dev");
+const USAGES_USAGE = commandUsage("plugin", "usages");
+const DELETE_USAGE = commandUsage("plugin", "delete");
+const CREATE_DEV_USAGE = commandUsage("plugin", "create-dev");
+const GET_GIT_REMOTE_USAGE = commandUsage("plugin", "get-git-remote");
+const SET_GIT_REMOTE_USAGE = commandUsage("plugin", "set-git-remote");
+const DELETE_GIT_REMOTE_USAGE = commandUsage("plugin", "delete-git-remote");
+const GIT_BRANCHES_USAGE = commandUsage("plugin", "git-branches");
+const PUSH_USAGE = commandUsage("plugin", "push");
+const PULL_USAGE = commandUsage("plugin", "pull");
+const FETCH_USAGE = commandUsage("plugin", "fetch");
+const RESET_LOCAL_USAGE = commandUsage("plugin", "reset-local");
+const RESET_REMOTE_USAGE = commandUsage("plugin", "reset-remote");
+const CONTENTS_LIST_USAGE = commandUsage("plugin", "contents-list");
+const CONTENTS_GET_USAGE = commandUsage("plugin", "contents-get");
+const CONTENTS_PUT_USAGE = commandUsage("plugin", "contents-put");
+const CONTENTS_DELETE_USAGE = commandUsage("plugin", "contents-delete");
+const DETAILS_USAGE = commandUsage("plugin", "details");
+const FOLDER_ADD_USAGE = commandUsage("plugin", "folder-add");
+const RENAME_USAGE = commandUsage("plugin", "rename");
+const MOVE_USAGE = commandUsage("plugin", "move");
 async function waitFuture(client, jobId, flags) {
     return client
         .futures.wait(jobId, {
@@ -103,10 +103,9 @@ async function waitFuture(client, jobId, flags) {
         timeoutMs: num(flags["timeout"], "--timeout"),
     });
 }
-export const pluginCommands = {
+export const pluginCommands = withUsage("plugin", {
     list: {
         handler: (c) => c.plugins.list(),
-        usage: LIST_USAGE,
         description: "List installed plugins (including development plugins).",
         examples: ["dss plugin list",],
     },
@@ -125,7 +124,6 @@ export const pluginCommands = {
             await c.plugins.installFromZip(file);
             return { installed: true, from: "zip", };
         },
-        usage: INSTALL_ZIP_USAGE,
         description: "Install a plugin from a zip file. Fails when the plugin is already installed (use update-from-zip to replace).",
         examples: ["dss plugin install-from-zip --file ./my-plugin.zip",],
     },
@@ -144,7 +142,6 @@ export const pluginCommands = {
             await c.plugins.installFromStore(pluginId);
             return { installed: pluginId, from: "store", };
         },
-        usage: INSTALL_STORE_USAGE,
         description: "Install a plugin from the Dataiku store. Fails when already installed.",
         examples: ["dss plugin install-from-store my-plugin",],
     },
@@ -177,7 +174,6 @@ export const pluginCommands = {
             });
             return { installed: true, from: "git", repositoryUrl: url, };
         },
-        usage: INSTALL_GIT_USAGE,
         description: "Install a plugin by checking out a Git repository (must contain plugin.json). Fails when already installed. HTTP(S) URLs must not embed credentials.",
         examples: [
             "dss plugin install-from-git --repository git@github.com:acme/my-plugin.git --checkout main",
@@ -195,7 +191,6 @@ export const pluginCommands = {
             const bytes = await writeResponseToFileForPlugin(out, res);
             return { path: out, bytes, };
         },
-        usage: DOWNLOAD_USAGE,
         description: "Download a development plugin as a zip archive to a local file.",
         examples: ["dss plugin download my-plugin --output ./my-plugin.zip",],
     },
@@ -215,7 +210,6 @@ export const pluginCommands = {
             await c.plugins.updateFromZip(pluginId, file);
             return { updated: pluginId, from: "zip", };
         },
-        usage: UPDATE_ZIP_USAGE,
         description: "Re-install a plugin from a zip file. Fails when the plugin is not already installed.",
         examples: ["dss plugin update-from-zip my-plugin --file ./my-plugin.zip",],
     },
@@ -233,7 +227,6 @@ export const pluginCommands = {
             await c.plugins.updateFromStore(pluginId);
             return { updated: pluginId, from: "store", };
         },
-        usage: UPDATE_STORE_USAGE,
         description: "Update a plugin from the Dataiku Store.",
         examples: ["dss plugin update-from-store my-plugin",],
     },
@@ -267,7 +260,6 @@ export const pluginCommands = {
             });
             return { updated: true, from: "git", repositoryUrl: url, };
         },
-        usage: UPDATE_GIT_USAGE,
         description: "Update an installed plugin from a Git repository (must contain plugin.json). Fails when not installed. HTTP(S) URLs must not embed credentials.",
         examples: [
             "dss plugin update-from-git my-plugin --repository git@github.com:acme/my-plugin.git --checkout v2",
@@ -280,7 +272,6 @@ export const pluginCommands = {
                 projectKey: optionalStringFlag(f, "project-key"),
             });
         },
-        usage: SETTINGS_GET_USAGE,
         description: "Get plugin settings (config parameters and code env name), optionally scoped to a project.",
         examples: ["dss plugin settings-get my-plugin --project-key MYPROJECT",],
     },
@@ -307,7 +298,6 @@ export const pluginCommands = {
             });
             return { updated: pluginId, settingsKeys: Object.keys(settings), };
         },
-        usage: SETTINGS_SET_USAGE,
         description: "Replace plugin settings. Send only settings previously obtained through settings-get; DSS rejects unknown shapes.",
         examples: [
             'dss plugin settings-set my-plugin --content \'{"config":{"key":"value"},"codeEnvName":"py-env"}\'',
@@ -337,7 +327,6 @@ export const pluginCommands = {
                 return future;
             return await waitFuture(c, future.jobId, f);
         },
-        usage: CODE_ENV_CREATE_USAGE,
         description: "Create the code env of a plugin. Returns the DSS future (jobId); --wait polls it to completion.",
         examples: [
             "dss plugin code-env-create my-plugin --python-interpreter PYTHON36",
@@ -361,7 +350,6 @@ export const pluginCommands = {
                 return future;
             return await waitFuture(c, future.jobId, f);
         },
-        usage: CODE_ENV_UPDATE_USAGE,
         description: "Update (rebuild) the code env of a plugin. Returns the DSS future (jobId); --wait polls it to completion.",
         examples: ["dss plugin code-env-update my-plugin --wait",],
     },
@@ -379,7 +367,6 @@ export const pluginCommands = {
             await c.plugins.moveToDev(pluginId);
             return { moved: pluginId, to: "dev", };
         },
-        usage: MOVE_TO_DEV_USAGE,
         description: "Move an installed plugin to the development environment for editing.",
         examples: ["dss plugin move-to-dev my-plugin",],
     },
@@ -390,7 +377,6 @@ export const pluginCommands = {
                 projectKey: optionalStringFlag(f, "project-key"),
             });
         },
-        usage: USAGES_USAGE,
         description: "List usages of a plugin's elements in projects or globally; missingTypes reports types the usage analysis could not resolve.",
         examples: ["dss plugin usages my-plugin --project-key MYPROJECT",],
     },
@@ -411,7 +397,6 @@ export const pluginCommands = {
             await c.plugins.delete(pluginId, { force, });
             return { deleted: pluginId, force, };
         },
-        usage: DELETE_USAGE,
         description: "Delete a plugin. DSS refuses when usages are detected unless --force is passed.",
         examples: ["dss plugin delete my-plugin", "dss plugin delete my-plugin --force",],
     },
@@ -450,7 +435,6 @@ export const pluginCommands = {
             });
             return { created: pluginId, creationMode, };
         },
-        usage: CREATE_DEV_USAGE,
         description: "Create a new development plugin: EMPTY, GIT_CLONE (clone the repository as the plugin), or GIT_EXPORT (use a subpath of the repository). HTTP(S) URLs must not embed credentials.",
         examples: [
             "dss plugin create-dev my-plugin",
@@ -462,7 +446,6 @@ export const pluginCommands = {
             requireArgs(a, 1, GET_GIT_REMOTE_USAGE);
             return c.plugins.getGitRemote(validatePluginId(a[0]));
         },
-        usage: GET_GIT_REMOTE_USAGE,
         description: "Get the Git remote declared for a development plugin (repositoryUrl is null when unset).",
         examples: ["dss plugin get-git-remote my-plugin",],
     },
@@ -486,7 +469,6 @@ export const pluginCommands = {
             const result = await c.plugins.setGitRemote(pluginId, url);
             return { pluginId, ...result, };
         },
-        usage: SET_GIT_REMOTE_USAGE,
         description: "Declare the Git remote for a development plugin. HTTP(S) URLs must not embed credentials; use SSH remotes or DSS-managed Git credentials.",
         examples: ["dss plugin set-git-remote my-plugin --repository git@github.com:acme/my-plugin.git",],
     },
@@ -504,7 +486,6 @@ export const pluginCommands = {
             await c.plugins.deleteGitRemote(pluginId);
             return { deleted: "gitRemote", pluginId, };
         },
-        usage: DELETE_GIT_REMOTE_USAGE,
         description: "Delete the Git remote declared for a development plugin.",
         examples: ["dss plugin delete-git-remote my-plugin",],
     },
@@ -513,7 +494,6 @@ export const pluginCommands = {
             requireArgs(a, 1, GIT_BRANCHES_USAGE);
             return c.plugins.listGitBranches(validatePluginId(a[0]));
         },
-        usage: GIT_BRANCHES_USAGE,
         description: "List the Git branches of a development plugin's declared remote.",
         examples: ["dss plugin git-branches my-plugin",],
     },
@@ -531,7 +511,6 @@ export const pluginCommands = {
             const result = await c.plugins.push(pluginId);
             return { pushed: pluginId, result, };
         },
-        usage: PUSH_USAGE,
         description: "Push the development plugin's content to its previously-declared Git remote.",
         examples: ["dss plugin push my-plugin",],
     },
@@ -549,7 +528,6 @@ export const pluginCommands = {
             const result = await c.plugins.pull(pluginId);
             return { pulled: pluginId, result, };
         },
-        usage: PULL_USAGE,
         description: "Pull (and rebase) the development plugin's content from its Git remote.",
         examples: ["dss plugin pull my-plugin",],
     },
@@ -567,7 +545,6 @@ export const pluginCommands = {
             const result = await c.plugins.fetch(pluginId);
             return { fetched: pluginId, result, };
         },
-        usage: FETCH_USAGE,
         description: "Fetch the development plugin's content from its Git remote without changing files.",
         examples: ["dss plugin fetch my-plugin",],
     },
@@ -585,7 +562,6 @@ export const pluginCommands = {
             const result = await c.plugins.resetToLocalHeadState(pluginId);
             return { reset: "localHeadState", pluginId, result, };
         },
-        usage: RESET_LOCAL_USAGE,
         description: "Reset the development plugin to its local HEAD state, discarding uncommitted edits.",
         examples: ["dss plugin reset-local my-plugin",],
     },
@@ -603,7 +579,6 @@ export const pluginCommands = {
             const result = await c.plugins.resetToRemoteHeadState(pluginId);
             return { reset: "remoteHeadState", pluginId, result, };
         },
-        usage: RESET_REMOTE_USAGE,
         description: "Reset the development plugin to the remote HEAD state, discarding local work. The remote must be declared first.",
         examples: ["dss plugin reset-remote my-plugin",],
     },
@@ -612,7 +587,6 @@ export const pluginCommands = {
             requireArgs(a, 1, CONTENTS_LIST_USAGE);
             return c.plugins.listContents(validatePluginId(a[0]));
         },
-        usage: CONTENTS_LIST_USAGE,
         description: "List the file tree of a development plugin.",
         examples: ["dss plugin contents-list my-plugin",],
     },
@@ -629,7 +603,6 @@ export const pluginCommands = {
             }
             return { data: await c.plugins.getFile(pluginId, path), };
         },
-        usage: CONTENTS_GET_USAGE,
         description: "Read a development plugin file as text. --output PATH writes the raw bytes to a local file instead.",
         examples: [
             "dss plugin contents-get my-plugin python/my-plugin.py",
@@ -666,7 +639,6 @@ export const pluginCommands = {
             const sha256 = hasher.digest("hex");
             return { written: path, pluginId, bytes, sha256, };
         },
-        usage: CONTENTS_PUT_USAGE,
         description: "Create or replace a development plugin file with text or binary content; reports the written byte count and sha256.",
         examples: [
             "dss plugin contents-put my-plugin python/lib.py --file ./lib.py",
@@ -688,7 +660,6 @@ export const pluginCommands = {
             await c.plugins.deleteFile(pluginId, path);
             return { deleted: path, pluginId, };
         },
-        usage: CONTENTS_DELETE_USAGE,
         description: "Delete a file (or folder) from a development plugin.",
         examples: ["dss plugin contents-delete my-plugin python/old.py",],
     },
@@ -697,7 +668,6 @@ export const pluginCommands = {
             requireArgs(a, 2, DETAILS_USAGE);
             return c.plugins.getFileDetails(validatePluginId(a[0]), validatePluginPath(a[1]));
         },
-        usage: DETAILS_USAGE,
         description: "Get a single development plugin file's detail record (size, mime type, timestamps).",
         examples: ["dss plugin details my-plugin python/my-plugin.py",],
     },
@@ -716,7 +686,6 @@ export const pluginCommands = {
             await c.plugins.addFolder(pluginId, path);
             return { created: path, pluginId, kind: "folder", };
         },
-        usage: FOLDER_ADD_USAGE,
         description: "Add a folder to a development plugin.",
         examples: ["dss plugin folder-add my-plugin python/mylib",],
     },
@@ -737,7 +706,6 @@ export const pluginCommands = {
             await c.plugins.rename(pluginId, path, newName);
             return { renamed: path, to: newName, pluginId, };
         },
-        usage: RENAME_USAGE,
         description: "Rename a file or folder inside a development plugin (same parent folder).",
         examples: ["dss plugin rename my-plugin python/old.py new.py",],
     },
@@ -758,11 +726,10 @@ export const pluginCommands = {
             await c.plugins.move(pluginId, path, destination);
             return { moved: path, to: destination, pluginId, };
         },
-        usage: MOVE_USAGE,
         description: "Move a file or folder inside a development plugin. The destination folder must already exist.",
         examples: ["dss plugin move my-plugin python/old.py python/mylib",],
     },
-};
+});
 /* ------------------------------------------------------------------ */
 /*  Helpers                                                            */
 /* ------------------------------------------------------------------ */

package/dist/src/cli/commands/project-deployer.js

@@ -1,9 +1,9 @@
 import { requiredJsonInput, } from "../coerce.js";
+import { commandUsage, withUsage, } from "../syntax.js";
 import { requireArgs, } from "../usage.js";
-export const projectDeployerCommands = {
+export const projectDeployerCommands = withUsage("project-deployer", {
     "list-projects": {
         handler: (c) => c.projectDeployer.listProjects(),
-        usage: "dss project-deployer list-projects",
         description: "List published projects on the Project Deployer.",
         examples: ["dss project-deployer list-projects",],
     },
@@ -12,32 +12,28 @@ export const projectDeployerCommands = {
             const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (published project settings).");
             return c.projectDeployer.createProject(body);
         },
-        usage: "dss project-deployer create-project (--data JSON|--data-file PATH|--stdin)",
         description: "Create a published project on the Project Deployer.",
         examples: ["dss project-deployer create-project --data-file project.json",],
     },
     "upload-bundle": {
         handler: async (c, a) => {
-            requireArgs(a, 1, "dss project-deployer upload-bundle <filePath>");
+            requireArgs(a, 1, commandUsage("project-deployer", "upload-bundle"));
             await c.projectDeployer.uploadBundle(a[0]);
             return { uploaded: true, };
         },
-        usage: "dss project-deployer upload-bundle <filePath>",
         description: "Upload a project bundle archive to the Project Deployer.",
         examples: ["dss project-deployer upload-bundle ./v1.zip",],
     },
     "project-status": {
         handler: (c, a) => {
-            requireArgs(a, 1, "dss project-deployer project-status <publishedProjectKey>");
+            requireArgs(a, 1, commandUsage("project-deployer", "project-status"));
             return c.projectDeployer.getProjectStatus(a[0]);
         },
-        usage: "dss project-deployer project-status <publishedProjectKey>",
         description: "Get a published project's status and available bundles.",
         examples: ["dss project-deployer project-status MYPROJ",],
     },
     "list-deployments": {
         handler: (c) => c.projectDeployer.listDeployments(),
-        usage: "dss project-deployer list-deployments",
         description: "List Project Deployer deployments.",
         examples: ["dss project-deployer list-deployments",],
     },
@@ -46,36 +42,32 @@ export const projectDeployerCommands = {
             const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (deployment settings).");
             return c.projectDeployer.createDeployment(body);
         },
-        usage: "dss project-deployer create-deployment (--data JSON|--data-file PATH|--stdin)",
         description: "Create a Project Deployer deployment (bundle to infra mapping).",
         examples: ["dss project-deployer create-deployment --data-file deployment.json",],
     },
     "get-deployment": {
         handler: (c, a) => {
-            requireArgs(a, 1, "dss project-deployer get-deployment <deploymentId>");
+            requireArgs(a, 1, commandUsage("project-deployer", "get-deployment"));
             return c.projectDeployer.getDeployment(a[0]);
         },
-        usage: "dss project-deployer get-deployment <deploymentId>",
         description: "Get a Project Deployer deployment.",
         examples: ["dss project-deployer get-deployment my-deployment",],
     },
     "deployment-status": {
         handler: (c, a) => {
-            requireArgs(a, 1, "dss project-deployer deployment-status <deploymentId>");
+            requireArgs(a, 1, commandUsage("project-deployer", "deployment-status"));
             return c.projectDeployer.getDeploymentStatus(a[0]);
         },
-        usage: "dss project-deployer deployment-status <deploymentId>",
         description: "Get a Project Deployer deployment's full health/status.",
         examples: ["dss project-deployer deployment-status my-deployment",],
     },
     "save-deployment-settings": {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss project-deployer save-deployment-settings <deploymentId> (--data JSON|--data-file PATH|--stdin)");
+            requireArgs(a, 1, commandUsage("project-deployer", "save-deployment-settings"));
             const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (deployment settings).");
             await c.projectDeployer.saveDeploymentSettings(a[0], body);
             return { saved: true, };
         },
-        usage: "dss project-deployer save-deployment-settings <deploymentId> (--data JSON|--data-file PATH|--stdin)",
         description: "Save a Project Deployer deployment's settings (e.g. bundleId).",
         examples: [
             "dss project-deployer save-deployment-settings my-deployment --data-file settings.json",
@@ -83,26 +75,23 @@ export const projectDeployerCommands = {
     },
     deploy: {
         handler: (c, a) => {
-            requireArgs(a, 1, "dss project-deployer deploy <deploymentId>");
+            requireArgs(a, 1, commandUsage("project-deployer", "deploy"));
             return c.projectDeployer.startUpdate(a[0]);
         },
-        usage: "dss project-deployer deploy <deploymentId>",
         description: "Apply a deployment to the Automation node (start update).",
         examples: ["dss project-deployer deploy my-deployment",],
     },
     "delete-deployment": {
         handler: async (c, a) => {
-            requireArgs(a, 1, "dss project-deployer delete-deployment <deploymentId>");
+            requireArgs(a, 1, commandUsage("project-deployer", "delete-deployment"));
             await c.projectDeployer.deleteDeployment(a[0]);
             return { deleted: true, };
         },
-        usage: "dss project-deployer delete-deployment <deploymentId>",
         description: "Delete a Project Deployer deployment.",
         examples: ["dss project-deployer delete-deployment my-deployment",],
     },
     "list-infras": {
         handler: (c) => c.projectDeployer.listInfras(),
-        usage: "dss project-deployer list-infras",
         description: "List Project Deployer infrastructures.",
         examples: ["dss project-deployer list-infras",],
     },
@@ -111,8 +100,7 @@ export const projectDeployerCommands = {
             const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (infra settings).");
             return c.projectDeployer.createInfra(body);
         },
-        usage: "dss project-deployer create-infra (--data JSON|--data-file PATH|--stdin)",
         description: "Create a Project Deployer infrastructure.",
         examples: ["dss project-deployer create-infra --data-file infra.json",],
     },
-};
+});

package/dist/src/cli/commands/project-folder.js

@@ -1,6 +1,7 @@
 import { requiredJsonInput, } from "../coerce.js";
 import { executionMode, } from "../flags.js";
 import { isNotFoundError, planResult, skipResult, } from "../output.js";
+import { commandUsage, withUsage, } from "../syntax.js";
 import { requireArgs, UsageError, } from "../usage.js";
 const PLAN_FAILURE_CODES = { usage: 1, error: 2, transient: 3, };
 function folderEndpoint(folderId, suffix = "") {
@@ -19,17 +20,16 @@ function nonEmptyPositionals(args, names, usage) {
         }
     });
 }
-const GET_USAGE = "dss project-folder get <folderId>";
-const SETTINGS_GET_USAGE = "dss project-folder settings-get <folderId>";
-const SETTINGS_SET_USAGE = "dss project-folder settings-set <folderId> (--data JSON|--data-file PATH|--stdin) [--dry-run]";
-const MOVE_USAGE = "dss project-folder move <folderId> <destinationFolderId> [--dry-run]";
-const DELETE_USAGE = "dss project-folder delete <folderId> [--if-exists] [--dry-run]";
-const CREATE_CHILD_USAGE = "dss project-folder create-child <parentFolderId> --name NAME [--dry-run]";
-const MOVE_PROJECT_USAGE = "dss project-folder move-project <folderId> <projectKey> <destinationFolderId> [--dry-run]";
-export const projectFolderCommands = {
+const GET_USAGE = commandUsage("project-folder", "get");
+const SETTINGS_GET_USAGE = commandUsage("project-folder", "settings-get");
+const SETTINGS_SET_USAGE = commandUsage("project-folder", "settings-set");
+const MOVE_USAGE = commandUsage("project-folder", "move");
+const DELETE_USAGE = commandUsage("project-folder", "delete");
+const CREATE_CHILD_USAGE = commandUsage("project-folder", "create-child");
+const MOVE_PROJECT_USAGE = commandUsage("project-folder", "move-project");
+export const projectFolderCommands = withUsage("project-folder", {
     root: {
         handler: (c) => c.projectFolders.root(),
-        usage: "dss project-folder root",
         description: "Get the root project folder definition (visible children and projects).",
         examples: ["dss project-folder root",],
     },
@@ -39,7 +39,6 @@ export const projectFolderCommands = {
             nonEmptyPositionals(a, ["folderId",], GET_USAGE);
         },
         handler: (c, a) => c.projectFolders.get(a[0]),
-        usage: GET_USAGE,
         description: "Get a project folder definition (children and project keys).",
         examples: ["dss project-folder get KdLmPU6",],
     },
@@ -49,7 +48,6 @@ export const projectFolderCommands = {
             nonEmptyPositionals(a, ["folderId",], SETTINGS_GET_USAGE);
         },
         handler: (c, a) => c.projectFolders.getSettings(a[0]),
-        usage: SETTINGS_GET_USAGE,
         description: "Get project folder settings (name, owner, permissions). Admin required.",
         examples: ["dss project-folder settings-get KdLmPU6",],
     },
@@ -75,7 +73,6 @@ export const projectFolderCommands = {
             await c.projectFolders.updateSettings(a[0], settings);
             return { updated: a[0], resource: "project-folder", };
         },
-        usage: SETTINGS_SET_USAGE,
         description: "Replace project folder settings (name, owner, permissions). Admin required.",
         examples: [
             "dss project-folder settings-set KdLmPU6 --data-file settings.json --dry-run",
@@ -101,7 +98,6 @@ export const projectFolderCommands = {
             await c.projectFolders.move(a[0], a[1]);
             return { moved: a[0], destination: a[1], resource: "project-folder", };
         },
-        usage: MOVE_USAGE,
         description: "Move a project folder (and its content) into another project folder. Cannot move into a sub-folder of itself.",
         examples: ["dss project-folder move KdLmPU6 dgKywsx",],
     },
@@ -136,7 +132,6 @@ export const projectFolderCommands = {
             await c.projectFolders.delete(a[0]);
             return { deleted: a[0], resource: "project-folder", };
         },
-        usage: DELETE_USAGE,
         description: "Delete an empty project folder (no sub-folders, no projects). Admin required.",
         examples: ["dss project-folder delete KdLmPU6 --dry-run",],
     },
@@ -166,7 +161,6 @@ export const projectFolderCommands = {
             const created = await c.projectFolders.createChild(a[0], name);
             return { created: created.id ?? name, resource: "project-folder", ...created, };
         },
-        usage: CREATE_CHILD_USAGE,
         description: "Create a sub-project folder. WRITE_CONTENTS required on the parent.",
         examples: ["dss project-folder create-child KdLmPU6 --name my_sub_folder",],
     },
@@ -190,8 +184,7 @@ export const projectFolderCommands = {
             await c.projectFolders.moveProject(a[0], a[1], a[2]);
             return { moved: a[1], destination: a[2], resource: "project-folder", };
         },
-        usage: MOVE_PROJECT_USAGE,
         description: "Move a project from its project folder to another project folder. WRITE_CONTENTS on destination and project admin required.",
         examples: ["dss project-folder move-project KdLmPU6 MYPROJECT dgKywsx",],
     },
-};
+});