@get-dx/cli 0.5.5 → 0.6.0

package/dist/cli.js

@@ -42,9 +42,10 @@ function createProgram() {
     program
         .name("dx")
         .description("DX CLI")
-        .version(cliPackage.version)
+        .version(cliPackage.version, "-v, --version")
         .addOption(new Option("--json", "Print machine-readable JSON"))
         .addOption(new Option("--agent <name>", "Agent name to send as an HTTP header"))
+        .addOption(new Option("--agent-model <model>", "Agent model name to send as an HTTP header"))
         .addOption(new Option("--agent-session-id <id>", "Agent session ID to send as an HTTP header"));
     program.addCommand(authCommand());
     program.addCommand(catalogCommand());

package/dist/commandHelpers.js

@@ -6,6 +6,7 @@ export function getContext(command) {
     return {
         json: Boolean(root.json),
         agent: root.agent || process.env.DX_AGENT_NAME,
+        agentModel: root.agentModel || process.env.DX_AGENT_MODEL,
         agentSessionId: root.agentSessionId || process.env.DX_AGENT_SESSION_ID,
     };
 }
@@ -101,6 +102,44 @@ export function createExampleText(examples) {
     }
     return lines.join("\n");
 }
+export function createNoteText(paragraphs) {
+    const width = getHelpWidth();
+    const indent = "  ";
+    const output = [];
+    output.push(""); // separate from the rest of the help text
+    output.push("Notes:");
+    paragraphs.forEach((paragraph, index) => {
+        if (index > 0) {
+            output.push(""); // blank line between paragraphs
+        }
+        output.push(...wrapParagraph(paragraph, width, indent));
+    });
+    return output.join("\n");
+}
+function getHelpWidth() {
+    return process.stdout.isTTY && process.stdout.columns
+        ? process.stdout.columns
+        : 80;
+}
+function wrapParagraph(text, width, indent) {
+    const words = text.split(/\s+/).filter(Boolean);
+    const lines = [];
+    let current = "";
+    for (const word of words) {
+        const candidate = current ? `${current} ${word}` : word;
+        if (current && indent.length + candidate.length > width) {
+            lines.push(`${indent}${current}`);
+            current = word;
+        }
+        else {
+            current = candidate;
+        }
+    }
+    if (current) {
+        lines.push(`${indent}${current}`);
+    }
+    return lines;
+}
 function inferContext(command, argv) {
     if (command) {
         return getContext(command);

package/dist/commands/studio/query.js

@@ -170,6 +170,9 @@ function buildHeaders(runtime, accept) {
     if (runtime.context.agent) {
         headers.set("X-DX-Agent-Name", runtime.context.agent);
     }
+    if (runtime.context.agentModel) {
+        headers.set("X-DX-Agent-Model", runtime.context.agentModel);
+    }
     if (runtime.context.agentSessionId) {
         headers.set("X-DX-Agent-Session-Id", runtime.context.agentSessionId);
     }

package/dist/commands/studio/report-blank-template.yaml

@@ -22,6 +22,11 @@ edit_access_type: read_only
 editor_emails: []
 
 # Supported chart_type values: line, pie, stacked_bar, scatter, table
+#
+# Tile sql can reference report variables (e.g. $team_ids, $start_date, or a
+# custom variable) as $variable_name. Variables themselves can't be managed
+# from the CLI/API — enable built-in variables or add/edit custom ones for
+# this report in the Data Studio UI, then reference them here.
 tiles:
   - title: ""
     sql: |-

package/dist/commands/studio/reports.js

@@ -1,12 +1,16 @@
 import fs from "fs";
 import { Command } from "commander";
 import { parse as parseYaml, stringify as stringifyYaml } from "yaml";
-import { createExampleText, getContext, parsePositiveIntOption, wrapAction, } from "../../commandHelpers.js";
+import { createExampleText, createNoteText, getContext, parsePositiveIntOption, wrapAction, } from "../../commandHelpers.js";
 import { CliError, EXIT_CODES, HttpError } from "../../errors.js";
 import { request } from "../../http.js";
 import { renderJson, renderRichText } from "../../renderers.js";
 import { buildRuntime } from "../../runtime.js";
 import * as ui from "../../ui.js";
+const VARIABLES_NOTE_TEXT = [
+    "Tile SQL can reference report variables using `$variable_name` syntax. Built-in variables — $service_ids, $team_ids, $tag_ids, $user_ids, $repo_ids, $start_date, $end_date — filter by service, team, attribute, user, repo, and date range, respectively. Custom variables are account-defined dropdown filters backed by a SQL query.",
+    "Variables cannot be created, updated, enabled, or disabled via this CLI or the API. Built-in variables must be toggled, and custom variables must be added, edited, or removed, from the report's settings in the Data Studio UI. Once a variable is enabled on a report, its `$variable_name` can be used in any tile's SQL via --from-file/--from-stdin.",
+];
 export function reportsCommand() {
     const reports = new Command()
         .name("reports")
@@ -16,6 +20,7 @@ export function reportsCommand() {
         .description("Create a Data Studio report from a YAML file or stdin")
         .option("--from-file <path>", "Read a YAML file and create a report from its contents")
         .option("--from-stdin", "Read YAML from stdin and create a report from its contents")
+        .addHelpText("afterAll", createNoteText(VARIABLES_NOTE_TEXT))
         .addHelpText("afterAll", createExampleText([
         {
             label: "Create a studio report from a YAML file",
@@ -174,6 +179,7 @@ export function reportsCommand() {
         .argument("<id>", "Studio report ID")
         .option("--from-file <path>", "Read a YAML file and update the report with its contents")
         .option("--from-stdin", "Read YAML from stdin and update the report with its contents")
+        .addHelpText("afterAll", createNoteText(VARIABLES_NOTE_TEXT))
         .addHelpText("afterAll", createExampleText([
         {
             label: "Initialize a file first",

package/dist/http.js

@@ -14,6 +14,9 @@ export async function request(runtime, route, options = {}) {
     if (runtime.context.agent) {
         headers.set("X-DX-Agent-Name", runtime.context.agent);
     }
+    if (runtime.context.agentModel) {
+        headers.set("X-DX-Agent-Model", runtime.context.agentModel);
+    }
     if (runtime.context.agentSessionId) {
         headers.set("X-DX-Agent-Session-Id", runtime.context.agentSessionId);
     }

package/dist/versionCheck.js

@@ -11,6 +11,7 @@ import cliPackage from "../package.json" with { type: "json" };
 const VERSION_CHECK_INTERVAL_HOURS = 24;
 const SNOOZE_DAYS = 7;
 const SKIP_COMMANDS = new Set(["auth", "init"]);
+const SKIP_OPTIONS = new Set(["-h", "--help", "-v", "--version"]);
 /**
  * Compares two semver strings (e.g. "1.2.3").
  * Returns a negative number if a < b, 0 if equal, positive if a > b.
@@ -67,13 +68,21 @@ export async function checkForNewVersion(argv) {
     if (process.env.DX_DISABLE_VERSION_CHECK) {
         return { status: "disabled" };
     }
-    const topLevelCommand = argv.slice(2).find((arg) => !arg.startsWith("-"));
+    const args = argv.slice(2);
+    if (args.some((arg) => SKIP_OPTIONS.has(arg))) {
+        return { status: "disabled" };
+    }
+    const topLevelCommand = args.find((arg) => !arg.startsWith("-"));
+    if (!topLevelCommand) {
+        return { status: "disabled" };
+    }
     if (topLevelCommand && SKIP_COMMANDS.has(topLevelCommand)) {
         return { status: "disabled" };
     }
     const context = {
         json: argv.includes("--json"),
         agent: undefined,
+        agentModel: undefined,
         agentSessionId: undefined,
     };
     const runtime = await buildRuntimeSafe(context);
@@ -137,6 +146,8 @@ export async function promptVersionUpdate(latestVersion) {
             { name: `Remind me later (in ${SNOOZE_DAYS} days)`, value: "snooze" },
             { name: "Skip this version", value: "skip" },
         ],
+    }, {
+        output: process.stderr,
     });
     if (choice === "update") {
         persistVersionPromptSelection(undefined);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@get-dx/cli",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "description": "DX CLI",
   "author": "DX <developers@getdx.com>",
   "bugs": {