@get-dx/cli 0.5.0 → 0.5.2

package/README.md

@@ -18,13 +18,6 @@ Interactively login and install the AI agent skill:
 dx init
 ```
 
-For CI, Docker/dev containers, or other headless environments, pass the token
-through the environment instead of storing it in the OS credential store:
-
-```shell
-DX_API_TOKEN="$DX_TOKEN" dx auth status
-```
-
 Show help text:
 
 ```shell
@@ -32,44 +25,9 @@ dx --help
 dx <subcommand> --help
 ```
 
-### Customizing base URLs
-
-The CLI requires two base URLs to be configured. The default values are used for DX **cloud** deployments. Users of **dedicated** and **managed** deployments will need to specify these values explicitly when logging in.
-
-| Value            | How it is used                               | Env var           | Default value           |
-| ---------------- | -------------------------------------------- | ----------------- | ----------------------- |
-| **Web base URL** | Browser-based login and displaying web links | `DX_WEB_BASE_URL` | `https://app.getdx.com` |
-| **API base URL** | Making each API request to DX                | `DX_API_BASE_URL` | `https://api.getdx.com` |
-
-#### For dedicated deployments
-
-Set the env vars once when initializing:
-
-```shell
-# Interactive login
-DX_WEB_BASE_URL="https://mycompany.getdx.io" DX_API_BASE_URL="https://api.mycompany.getdx.io" dx init
-
-# Non-interactive use for CI, containers, or remote agents
-DX_WEB_BASE_URL="https://mycompany.getdx.io" DX_API_BASE_URL="https://api.mycompany.getdx.io" DX_API_TOKEN="$DX_TOKEN" dx auth status
-```
-
-#### For managed deployments
-
-Set the env vars once when initializing:
-
-```shell
-# Interactive login
-DX_WEB_BASE_URL="https://dx.some-example-subdomain.example.com" DX_API_BASE_URL="https://api.dx.some-example-subdomain.example.com" dx init
-
-# Non-interactive use for CI, containers, or remote agents
-DX_WEB_BASE_URL="https://dx.some-example-subdomain.example.com" DX_API_BASE_URL="https://api.dx.some-example-subdomain.example.com" DX_API_TOKEN="$DX_TOKEN" dx auth status
-```
-
-## Logging
-
-Set `DX_LOG_LEVEL` to one of `debug`, `info`, `warn`, or `error` to enable CLI logs.
+## Documentation
 
-Logs are always written to `stderr`. They are human-readable by default, and switch to JSON when `--json` is present or `stderr` is not a TTY.
+For usage instructions and for more information about configuration, visit the [DX CLI documentation](https://docs.getdx.com/cli/).
 
 ## Developing the CLI
 

package/dist/commands/auth.js

@@ -2,7 +2,7 @@ import { password, select } from "@inquirer/prompts";
 import { Command } from "commander";
 import { deleteToken, setToken } from "../secrets.js";
 import { renderJson } from "../renderers.js";
-import { renderAuthInfo, renderLoggedOut } from "./authRendering.js";
+import { renderAuthInfo, renderAuthWhoami, renderLoggedOut, } from "./authRendering.js";
 import { createExampleText, getContext, wrapAction, } from "../commandHelpers.js";
 import { persistBaseUrls, resolveApiBaseUrl, deriveBaseUrlsFromEnv, } from "../config.js";
 import { CliError } from "../errors.js";
@@ -51,12 +51,12 @@ export function authCommand() {
             }
             else {
                 token = await password({
-                    message: "Paste your account web API token here:",
+                    message: "Paste your personal access token or organization token here:",
                     mask: true,
                 });
             }
             if (!token) {
-                throw new CliError("Account web API token or personal access token is required");
+                throw new CliError("Personal access token or organization token is required");
             }
         }
         const runtime = await buildRuntime(context, {
@@ -128,6 +128,29 @@ export function authCommand() {
             renderAuthInfo(response, runtime.token, runtime.apiBaseUrl);
         }
     }));
+    auth
+        .command("whoami")
+        .description("Show user and team details for the authenticated token")
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "Fetch user and team details",
+            command: "dx auth whoami",
+        },
+        {
+            label: "Fetch user and team details as JSON",
+            command: "dx auth whoami --json",
+        },
+    ]))
+        .action(wrapAction(async (_options, command) => {
+        const runtime = await buildRuntime(getContext(command));
+        const response = await getAuthWhoami(runtime);
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderAuthWhoami(response);
+        }
+    }));
     return auth;
 }
 // TODO: should we move this somewhere more central, since `init` needs it?
@@ -137,3 +160,9 @@ export async function getAuthInfo(runtime) {
     });
     return response.body;
 }
+export async function getAuthWhoami(runtime) {
+    const response = await request(runtime, "/auth.whoami", {
+        method: "GET",
+    });
+    return response.body;
+}

package/dist/commands/authRendering.js

@@ -37,10 +37,51 @@ function scopesContent(scopes) {
         ];
     }
 }
+export function renderAuthWhoami(response) {
+    const blocks = [];
+    // Auth section
+    blocks.push(ui.h3("Auth"));
+    blocks.push(ui.dl([
+        ui.dli("Account", response.account.name),
+        ui.dli("Token type", tokenTypeName(response.auth_token_type)),
+    ], { termWidth: 12 }));
+    // User section
+    blocks.push(ui.h3("Current user"));
+    if (response.user) {
+        blocks.push(ui.dl([
+            ui.dli("ID", ui.code(response.user.id)),
+            ui.dli("Name", response.user.name),
+            ui.dli("Email", response.user.email),
+        ], { termWidth: 7 }));
+    }
+    else {
+        blocks.push(ui.p(ui.dim("Not available for organization tokens")));
+    }
+    // Team section
+    blocks.push(ui.h3("Team"));
+    if (response.team) {
+        blocks.push(ui.dl([
+            ui.dli("ID", ui.code(response.team.id)),
+            ui.dli("Name", response.team.name),
+            ui.dli("Lead", formatUser(response.team.lead)),
+        ], { termWidth: 6 }));
+        if (response.team.contributors.length > 0) {
+            blocks.push(ui.p(ui.bold("Contributors:"), false));
+            blocks.push(ui.ul(response.team.contributors.map((c) => ui.li(formatUser(c)))));
+        }
+    }
+    else {
+        blocks.push(ui.p(ui.dim("Not available for organization tokens")));
+    }
+    renderRichText(blocks);
+}
+function formatUser(user) {
+    return `${user.name} ${ui.dim(`(${user.id}, ${user.email})`)}`;
+}
 function tokenTypeName(tokenType) {
     switch (tokenType) {
         case "account_web_api_token":
-            return "Account-level web API token";
+            return "Organization token";
         case "personal_access_token":
             return "Personal access token";
         default:

package/dist/commands/catalog/entities.js

@@ -22,7 +22,7 @@ export function entitiesCommand() {
         .option("--owner-user-emails <emails>", "Comma-separated owner user emails")
         .option("--owner-user-ids <ids>", "Comma-separated owner user IDs")
         .option("--property <kv>", "Set a property value as key=value. Repeat for multiple properties.", (val, prev) => [...prev, val], [])
-        .option("--alias <kv>", "Set an alias value as key=value. Repeat for multiple aliases.", (val, prev) => [...prev, val], [])
+        .option("--alias <kv>", "Set an alias as <type>=<identifier> (short form) or type=<type>,identifier=<id>[,instance_identifier=<instance_id>] (long form). Repeat for multiple aliases.", (val, prev) => [...prev, val], [])
         .addHelpText("afterAll", createExampleText([
         {
             label: "Create a new service entity",
@@ -41,9 +41,13 @@ export function entitiesCommand() {
             command: 'dx catalog entities create --type service --identifier my-service --property tier=Tier-1 --property "languages=Ruby,TypeScript"',
         },
         {
-            label: "Create with aliases",
+            label: "Create with alias (short form)",
             command: "dx catalog entities create --type service --identifier my-service --alias github_repo=12345",
         },
+        {
+            label: "Create with alias (long form, includes instance identifier)",
+            command: 'dx catalog entities create --type service --identifier my-service --alias "type=github_repo,identifier=12345,instance_identifier=789"',
+        },
     ]))
         .action(wrapAction(async (options, command) => {
         if (!options.identifier) {
@@ -104,7 +108,7 @@ export function entitiesCommand() {
         .option("--owner-user-emails <emails>", "Comma-separated owner user emails")
         .option("--owner-user-ids <ids>", "Comma-separated owner user IDs")
         .option("--property <kv>", "Set a property value as key=value. Repeat for multiple properties. Use value null to remove a property.", (val, prev) => [...prev, val], [])
-        .option("--alias <kv>", "Set an alias value as key=value. Repeat for multiple aliases. Use value null to remove an alias.", (val, prev) => [...prev, val], [])
+        .option("--alias <kv>", "Set an alias as <type>=<identifier> (short form) or type=<type>,identifier=<id>[,instance_identifier=<instance_id>] (long form). Repeat for multiple aliases. Use value null to remove an alias.", (val, prev) => [...prev, val], [])
         .addHelpText("afterAll", createExampleText([
         {
             label: "Rename an entity",
@@ -119,9 +123,13 @@ export function entitiesCommand() {
             command: 'dx catalog entities update my-service --property tier=Tier-1 --property "languages=Ruby,TypeScript"',
         },
         {
-            label: "Update aliases",
+            label: "Update alias (short form)",
             command: "dx catalog entities update my-service --alias github_repo=12345",
         },
+        {
+            label: "Update alias (long form, includes instance identifier)",
+            command: 'dx catalog entities update my-service --alias "type=github_repo,identifier=12345,instance_identifier=789"',
+        },
     ]))
         .action(wrapAction(async (identifier, options, command) => {
         const runtime = await buildRuntime(getContext(command));
@@ -148,7 +156,7 @@ export function entitiesCommand() {
         .option("--owner-user-emails <emails>", "Comma-separated owner user emails")
         .option("--owner-user-ids <ids>", "Comma-separated owner user IDs")
         .option("--property <kv>", "Set a property value as key=value. Repeat for multiple properties. Use value null to remove a property.", (val, prev) => [...prev, val], [])
-        .option("--alias <kv>", "Set an alias value as key=value. Repeat for multiple aliases. Use value null to remove an alias.", (val, prev) => [...prev, val], [])
+        .option("--alias <kv>", "Set an alias as <type>=<identifier> (short form) or type=<type>,identifier=<id>[,instance_identifier=<instance_id>] (long form). Repeat for multiple aliases. Use value null to remove an alias.", (val, prev) => [...prev, val], [])
         .addHelpText("afterAll", createExampleText([
         {
             label: "Create a new service entity if it does not exist",
@@ -163,9 +171,13 @@ export function entitiesCommand() {
             command: 'dx catalog entities upsert --type service --identifier my-service --property tier=Tier-1 --property "languages=Ruby,TypeScript"',
         },
         {
-            label: "Set aliases while preserving omitted fields",
+            label: "Set alias (short form) while preserving omitted fields",
             command: "dx catalog entities upsert --type service --identifier my-service --alias github_repo=12345",
         },
+        {
+            label: "Set alias (long form, includes instance identifier)",
+            command: 'dx catalog entities upsert --type service --identifier my-service --alias "type=github_repo,identifier=12345,instance_identifier=789"',
+        },
     ]))
         .action(wrapAction(async (options, command) => {
         if (!options.type) {
@@ -493,17 +505,47 @@ export function parsePropertyValue(prop, rawValue) {
             return rawValue;
     }
 }
+function parseAliasInput(kv) {
+    // Long form: type=<alias_type>,identifier=<lookup>[,instance_identifier=<instance_id>]
+    if (kv.includes(",")) {
+        const pairs = {};
+        let validPairs = true;
+        for (const pair of kv.split(",")) {
+            const eqIdx = pair.indexOf("=");
+            if (eqIdx === -1) {
+                validPairs = false;
+                break;
+            }
+            pairs[pair.slice(0, eqIdx)] = pair.slice(eqIdx + 1);
+        }
+        if (validPairs &&
+            pairs.type !== undefined &&
+            pairs.identifier !== undefined) {
+            return {
+                key: pairs.type,
+                lookup: pairs.identifier,
+                ...(pairs.instance_identifier !== undefined
+                    ? { instance_identifier: pairs.instance_identifier }
+                    : {}),
+            };
+        }
+    }
+    // Short form: <alias_type>=<lookup>
+    const eqIndex = kv.indexOf("=");
+    if (eqIndex === -1)
+        return null;
+    return { key: kv.slice(0, eqIndex), lookup: kv.slice(eqIndex + 1) };
+}
 function parseEntityAliases(entityTypeIdentifier, rawAliases, knownAliases) {
     const aliasKeys = Object.keys(knownAliases);
     const aliasSet = new Set(aliasKeys);
     const result = {};
     for (const kv of rawAliases) {
-        const eqIndex = kv.indexOf("=");
-        if (eqIndex === -1) {
-            throw new CliError(`Invalid --alias "${kv}": expected format key=value`, EXIT_CODES.ARGUMENT_ERROR);
+        const parsed = parseAliasInput(kv);
+        if (!parsed) {
+            throw new CliError(`Invalid --alias "${kv}": expected format key=value or type=<type>,identifier=<id>[,instance_identifier=<instance_id>]`, EXIT_CODES.ARGUMENT_ERROR);
         }
-        const key = kv.slice(0, eqIndex);
-        const rawValue = kv.slice(eqIndex + 1);
+        const { key, lookup, instance_identifier } = parsed;
         if (!aliasSet.has(key)) {
             const availableAliases = aliasKeys
                 .sort()
@@ -512,11 +554,15 @@ function parseEntityAliases(entityTypeIdentifier, rawAliases, knownAliases) {
             const availableAliasesText = availableAliases.length > 0 ? availableAliases : "(none)";
             throw new CliError(`Unknown alias \`${key}\` for entity type \`${entityTypeIdentifier}\`. Available aliases: ${availableAliasesText}`, EXIT_CODES.ARGUMENT_ERROR);
         }
-        if (rawValue === "null") {
+        if (lookup === "null") {
             result[key] = [];
             continue;
         }
-        result[key] = [...(result[key] ?? []), { lookup: rawValue }];
+        const aliasEntry = { lookup };
+        if (instance_identifier !== undefined) {
+            aliasEntry.instance_identifier = instance_identifier;
+        }
+        result[key] = [...(result[key] ?? []), aliasEntry];
     }
     return result;
 }

package/dist/commands/init.js

@@ -83,12 +83,12 @@ async function attemptLogin(apiBaseUrl, webBaseUrl, context) {
     }
     else {
         token = await password({
-            message: "Paste your account web API token here:",
+            message: "Paste your personal access token or organization token here:",
             mask: true,
         });
     }
     if (!token) {
-        throw new CliError("Account web API token is required");
+        throw new CliError("Personal access token or organization token is required");
     }
     const runtime = await buildRuntime(context, {
         apiBaseUrl,

package/package.json

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