@get-dx/cli 0.1.3 → 0.1.5

package/dist/cli.js

@@ -4,6 +4,7 @@ import { catalogCommand } from "./commands/catalog.js";
 import { initCommand } from "./commands/init.js";
 import { scorecardsCommand } from "./commands/scorecards.js";
 import { studioCommand } from "./commands/studio.js";
+import { teamsCommand } from "./commands/teams.js";
 import { handleError } from "./commandHelpers.js";
 import cliPackage from "../package.json" with { type: "json" };
 export async function run(argv = process.argv) {
@@ -33,6 +34,7 @@ function createProgram() {
     program.addCommand(initCommand());
     program.addCommand(scorecardsCommand());
     program.addCommand(studioCommand());
+    program.addCommand(teamsCommand());
     applyExitOverride(program);
     return program;
 }
@@ -45,7 +47,7 @@ function createProgram() {
  */
 function applyExitOverride(cmd) {
     cmd.exitOverride();
-    cmd.configureOutput({ writeErr: () => { } });
+    cmd.configureOutput({ outputError: () => { } });
     for (const sub of cmd.commands) {
         applyExitOverride(sub);
     }

package/dist/commandHelpers.js

@@ -58,6 +58,10 @@ export function handleError(error, command, argv) {
         if (error instanceof HttpError) {
             process.stderr.write(`The API returned an error with status code ${error.status}:\n\n${JSON.stringify(error.body, null, 2)}\n`);
         }
+        else if (error instanceof CommanderError &&
+            (error.code === "commander.help" || error.message === "(outputHelp)")) {
+            // Commander already printed the relevant help text.
+        }
         else {
             process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
         }

package/dist/commands/init.js

@@ -160,7 +160,7 @@ async function optionallySetupSkill(runtime) {
     renderRichText([
         ui.p(`The DX skill is not installed. Would you like to install it?`),
         ui.p("This will run the following command:", false),
-        ui.codeBlock("npx --yes -- skills@latest add get-dx/dx-cli --global"),
+        ui.codeBlock("npx --yes -- skills@latest add get-dx/cli --global"),
         ui.blankLine(),
     ]);
     const setupSkill = await confirm({
@@ -174,17 +174,18 @@ async function optionallySetupSkill(runtime) {
         return;
     }
     renderRichText([ui.p(`Setting up the DX skill...`)]);
+    // NOTE: if the user chooses "no" for the final confirmation prompt, `skills` still exits with a 0 status.
+    // We are also not able to pipe the output without also breaking interactivity.
     const result = await execa({
         stdout: "inherit",
         stderr: "inherit",
         stdin: "inherit",
-    }) `npx --yes -- skills@latest add get-dx/dx-cli --global`;
+    }) `npx --yes -- skills@latest add get-dx/cli --global`;
     runtime.logger.debug("To update: npx skills update dx-cli --global");
     runtime.logger.debug("To uninstall: npx skills remove dx-cli --global");
     if (result.exitCode !== 0) {
         throw new CliError(`Failed to setup the DX skill: ${result.stderr}`);
     }
-    renderRichText([ui.p(`DX skill setup successful.`)]);
 }
 function createEmptyContext() {
     return {

package/dist/commands/studio/query.js

@@ -21,6 +21,7 @@ export function queryCommand() {
         .description("Execute a Data Studio SQL query and wait for the results")
         .argument("<sql>", "SQL query to execute")
         .option("--output <filename>", "Save the full result set as CSV to a file")
+        .option("--variable <key=value>", "Set a template variable referenced in the SQL (can be repeated; use comma-separated values for arrays)", (val, prev) => [...prev, val], [])
         .addHelpText("afterAll", createExampleText([
         {
             label: "Run a query and print the results as a table",
@@ -28,21 +29,30 @@ export function queryCommand() {
         },
         {
             label: "Run a query and print the JSON results payload",
-            command: "dx studio query 'SELECT id, name FROM github_repos LIMIT 5' --json",
+            command: "dx studio query 'SELECT id, name FROM github_repositories LIMIT 5' --json",
         },
         {
             label: "Run a query and save the full result set as CSV",
             command: "dx studio query 'SELECT * FROM github_pulls' --output pulls.csv",
         },
+        {
+            label: "Run a parameterized query with a scalar variable",
+            command: "dx studio query 'SELECT * FROM github_repositories WHERE name = $name' --variable name=my-repo",
+        },
+        {
+            label: "Run a parameterized query with an array variable",
+            command: "dx studio query 'SELECT * FROM github_repositories WHERE id IN ($repo_ids)' --variable repo_ids=1,2,3",
+        },
     ]))
         .action(wrapAction(async (sql, options, command) => {
         const context = getContext(command);
         if (context.json && options.output) {
             throw new CliError("--output cannot be used with --json", EXIT_CODES.ARGUMENT_ERROR);
         }
+        const variables = parseVariables(options.variable);
         const runtime = buildRuntime(context);
         const progress = new QueryProgressReporter();
-        const queryRun = await executeQuery(runtime, progress, sql);
+        const queryRun = await executeQuery(runtime, progress, sql, variables);
         await waitForQuery(runtime, progress, queryRun.id);
         if (options.output) {
             await downloadStudioQueryResultsCsv(runtime, queryRun.id, options.output);
@@ -58,11 +68,11 @@ export function queryCommand() {
         }
     }));
 }
-async function executeQuery(runtime, progress, sql) {
+async function executeQuery(runtime, progress, sql, variables) {
     try {
         renderRunningQuery(sql);
         progress.start(ui.bold("Submitting query"));
-        const executeResponse = await executeStudioQuery(runtime, sql);
+        const executeResponse = await executeStudioQuery(runtime, sql, variables);
         const queryRun = executeResponse.body.query_run;
         await waitForRetryAfter(executeResponse.retryAfterMs);
         return queryRun;
@@ -115,10 +125,10 @@ function renderRunningQuery(sql) {
 function renderPendingQueryStatus(queryRunId) {
     return `${ui.bold("Query running")} ${ui.dim(`(${queryRunId})`)}`;
 }
-async function executeStudioQuery(runtime, sql) {
+async function executeStudioQuery(runtime, sql, variables) {
     return request(runtime, "/studio.queryRuns.execute", {
         method: "POST",
-        body: { sql },
+        body: variables ? { sql, variables } : { sql },
     });
 }
 async function getStudioQueryRun(runtime, id) {
@@ -262,6 +272,24 @@ async function writeResponseBodyToFile(response, filename) {
         reader.releaseLock();
     }
 }
+function parseVariables(vars) {
+    if (vars.length === 0)
+        return undefined;
+    const result = {};
+    for (const v of vars) {
+        const eqIdx = v.indexOf("=");
+        if (eqIdx === -1) {
+            throw new CliError(`Invalid variable format: "${v}". Expected key=value.`, EXIT_CODES.ARGUMENT_ERROR);
+        }
+        const key = v.slice(0, eqIdx);
+        const raw = v.slice(eqIdx + 1);
+        const parts = raw.includes(",") ? raw.split(",") : [raw];
+        const coerced = parts.map((p) => p !== "" && !isNaN(Number(p)) ? Number(p) : p);
+        result[key] =
+            coerced.length === 1 ? coerced[0] : coerced;
+    }
+    return result;
+}
 function buildFailedQueryError(error) {
     if (!error) {
         return new CliError("Query failed.", 1);

package/dist/commands/teams.js

@@ -0,0 +1,69 @@
+import { Command } from "commander";
+import { createExampleText, getContext, wrapAction, } from "../commandHelpers.js";
+import { request } from "../http.js";
+import { renderJson, renderRichText } from "../renderers.js";
+import { buildRuntime } from "../runtime.js";
+import * as ui from "../ui.js";
+export function teamsCommand() {
+    const teams = new Command().name("teams").description("Manage DX teams");
+    teams
+        .command("list")
+        .description("List all teams in DX")
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "List all teams",
+            command: "dx teams list",
+        },
+        {
+            label: "List all teams as JSON",
+            command: "dx --json teams list",
+        },
+    ]))
+        .action(wrapAction(async (_options, command) => {
+        const runtime = buildRuntime(getContext(command));
+        const response = await listTeams(runtime);
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderTeams(response.teams);
+        }
+    }));
+    return teams;
+}
+async function listTeams(runtime) {
+    const response = await request(runtime, "/teams.list", {
+        method: "GET",
+    });
+    return response.body;
+}
+function renderTeams(teams) {
+    const blocks = [ui.h1("Teams")];
+    blocks.push(ui.p(`Displaying ${ui.bold(teams.length.toString())} teams.`));
+    for (const team of teams) {
+        blocks.push(ui.h2(`${team.name} (${ui.code(team.id)})`));
+        blocks.push(ui.dl([
+            ui.dli("Reference ID", formatText(team.reference_id)),
+            ui.dli("Parent ID", formatText(team.parent_id)),
+            ui.dli("Manager ID", formatText(team.manager_id)),
+            ui.dli("Ancestors", team.ancestors && team.ancestors.length > 0
+                ? team.ancestors.map((ancestor) => ui.code(ancestor)).join(", ")
+                : ui.dim("(None)")),
+            ui.dli("Contributors", typeof team.contributors === "number"
+                ? team.contributors.toString()
+                : ui.dim("(Unknown)")),
+            ui.dli("Parent team", typeof team.parent === "boolean"
+                ? team.parent
+                    ? "Yes"
+                    : "No"
+                : ui.dim("(Unknown)")),
+            ui.dli("Last changed", team.last_changed_at
+                ? ui.timestampSummary(team.last_changed_at)
+                : ui.dim("(None)")),
+        ], { termWidth: 14 }));
+    }
+    renderRichText(blocks);
+}
+function formatText(value) {
+    return value ? ui.code(value) : ui.dim("(None)");
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@get-dx/cli",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "DX CLI",
   "author": "DX <developers@getdx.com>",
   "bugs": {
@@ -16,7 +16,7 @@
   "homepage": "https://github.com/get-dx/cli#readme",
   "license": "Apache-2.0",
   "engines": {
-    "node": "20.x"
+    "node": "^20.0.0 || ^22.0.0 || ^24.0.0"
   },
   "private": false,
   "publishConfig": {