@arizeai/phoenix-cli 0.12.0 → 0.12.1

package/README.md

@@ -291,6 +291,21 @@ px session my-session-id --include-annotations --format raw | jq '.traces'
 
 ---
 
+### `px annotation-config`
+
+List annotation configurations defined in your Phoenix instance.
+
+```bash
+px annotation-config --format raw --no-progress | jq '.[].name'
+```
+
+| Option              | Description                | Default  |
+| ------------------- | -------------------------- | -------- |
+| `--format <format>` | `pretty`, `json`, or `raw` | `pretty` |
+| `--no-progress`     | Suppress progress output   | —        |
+
+---
+
 ### `px auth status`
 
 Show current Phoenix authentication status, including the configured endpoint, whether you are authenticated or anonymous, and an obscured API key.

package/build/commands/auth.d.ts

@@ -1,11 +1,27 @@
+import type { componentsV1 } from "@arizeai/phoenix-client";
 import { Command } from "commander";
+type ViewerUser = componentsV1["schemas"]["GetViewerResponseBody"]["data"];
 /**
  * Obscure an API key for display using asterisks.
  * Shows a fixed number of asterisks regardless of key length for security.
  */
 export declare function obscureApiKey(apiKey: string): string;
+interface FetchViewerSuccess {
+    status: "success";
+    user: ViewerUser;
+}
+interface FetchViewerError {
+    status: "network_error" | "auth_error" | "not_found" | "unknown_error";
+    message: string;
+}
+export type FetchViewerResult = FetchViewerSuccess | FetchViewerError;
+/**
+ * Format auth status output in gh-style format.
+ */
+export declare function formatAuthStatus(endpoint: string, result: FetchViewerResult, apiKey?: string): string;
 /**
  * Create the auth command with subcommands
  */
 export declare function createAuthCommand(): Command;
+export {};
 //# sourceMappingURL=auth.d.ts.map

package/build/commands/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/commands/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAYpC;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKpD;AA8CD;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAS3C"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/commands/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAOpC,KAAK,UAAU,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAO3E;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKpD;AAED,UAAU,kBAAkB;IAC1B,MAAM,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,UAAU,gBAAgB;IACxB,MAAM,EAAE,eAAe,GAAG,YAAY,GAAG,WAAW,GAAG,eAAe,CAAC;IACvE,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,gBAAgB,CAAC;AAuCtE;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,CAiCR;AA6DD;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAS3C"}

package/build/commands/auth.js

@@ -1,8 +1,8 @@
 import { Command } from "commander";
+import { createPhoenixClient } from "../client.js";
 import { resolveConfig } from "../config.js";
 import { ExitCode } from "../exitCodes.js";
 import { writeError, writeOutput } from "../io.js";
-import { formatTable } from "./formatTable.js";
 /**
  * Obscure an API key for display using asterisks.
  * Shows a fixed number of asterisks regardless of key length for security.
@@ -13,30 +13,115 @@ export function obscureApiKey(apiKey) {
     }
     return "************************************";
 }
+/**
+ * Extract an HTTP status code from the phoenix-client middleware error message.
+ * The middleware throws errors like: "https://example.org/api/v1/user: 401 Unauthorized"
+ */
+function parseStatusCode(error) {
+    const match = error.message.match(/:\s*(\d{3})\s/);
+    return match ? parseInt(match[1], 10) : null;
+}
+/**
+ * Fetch the authenticated viewer from the Phoenix server.
+ * Gracefully handles network errors, auth failures, and missing endpoints.
+ */
+async function fetchViewer(config) {
+    try {
+        const client = createPhoenixClient({ config });
+        const response = await client.GET("/v1/user");
+        return { status: "success", user: response.data.data };
+    }
+    catch (error) {
+        // TypeError is thrown by the Fetch API for network-level failures
+        if (error instanceof TypeError) {
+            return { status: "network_error", message: error.message };
+        }
+        if (error instanceof Error) {
+            const statusCode = parseStatusCode(error);
+            if (statusCode === 401 || statusCode === 403) {
+                return { status: "auth_error", message: error.message };
+            }
+            if (statusCode === 404) {
+                return { status: "not_found", message: error.message };
+            }
+            return { status: "unknown_error", message: error.message };
+        }
+        return { status: "unknown_error", message: String(error) };
+    }
+}
+/**
+ * Format auth status output in gh-style format.
+ */
+export function formatAuthStatus(endpoint, result, apiKey) {
+    const lines = [endpoint];
+    if (result.status === "success") {
+        const user = result.user;
+        if (user.auth_method === "ANONYMOUS") {
+            lines.push("  \u2713 Authentication not required (anonymous)");
+        }
+        else {
+            lines.push(`  \u2713 Logged in as ${user.username} (api key)`);
+            lines.push(`  - Role: ${user.role}`);
+        }
+    }
+    else if (result.status === "auth_error") {
+        lines.push("  \u2717 Authentication failed (invalid or expired token)");
+    }
+    else if (result.status === "not_found") {
+        lines.push("  - Could not verify token (server does not support user endpoint)");
+    }
+    else {
+        // network_error or unknown_error
+        if (apiKey) {
+            lines.push("  \u2717 Token configured but could not verify (server unreachable)");
+        }
+        else {
+            lines.push("  \u2717 Could not connect to server");
+        }
+    }
+    if (apiKey) {
+        lines.push(`  - Token: ${obscureApiKey(apiKey)}`);
+    }
+    return lines.join("\n");
+}
+function exitCodeForResult(result) {
+    switch (result.status) {
+        case "success":
+        // 404 means the server is an older version without /v1/user — the token
+        // may still be valid, we just can't verify it. Not a failure.
+        case "not_found":
+            return ExitCode.SUCCESS;
+        case "auth_error":
+            return ExitCode.AUTH_REQUIRED;
+        case "network_error":
+            return ExitCode.NETWORK_ERROR;
+        case "unknown_error":
+            return ExitCode.FAILURE;
+    }
+}
 /**
  * Auth status command handler
  */
 async function authStatusHandler(options) {
-    // Resolve configuration
     const config = resolveConfig({
         cliOptions: {
             endpoint: options.endpoint,
             apiKey: options.apiKey,
         },
     });
-    // Check if endpoint is configured
     if (!config.endpoint) {
         writeError({
             message: "Configuration Error:\n  - Phoenix endpoint not configured",
         });
         process.exit(ExitCode.INVALID_ARGUMENT);
     }
-    const row = {
-        endpoint: config.endpoint,
-        status: config.apiKey ? "authenticated" : "anonymous",
-        "api key": config.apiKey ? obscureApiKey(config.apiKey) : "not set",
-    };
-    writeOutput({ message: formatTable([row]) });
+    const result = await fetchViewer(config);
+    const output = formatAuthStatus(config.endpoint, result, config.apiKey);
+    writeOutput({ message: output });
+    const code = exitCodeForResult(result);
+    if (code !== ExitCode.SUCCESS) {
+        process.exit(code);
+    }
 }
 /**
  * Create the auth status subcommand

package/build/commands/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/commands/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAO5C;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,sCAAsC,CAAC;AAChD,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,iBAAiB,CAAC,OAA0B;IACzD,wBAAwB;IACxB,MAAM,MAAM,GAAG,aAAa,CAAC;QAC3B,UAAU,EAAE;YACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB;KACF,CAAC,CAAC;IAEH,kCAAkC;IAClC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,UAAU,CAAC;YACT,OAAO,EAAE,2DAA2D;SACrE,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,GAAG,GAA2B;QAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,WAAW;QACrD,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;KACpE,CAAC;IAEF,WAAW,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB;IAC9B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtC,OAAO;SACJ,WAAW,CAAC,4CAA4C,CAAC;SACzD,MAAM,CAAC,kBAAkB,EAAE,sBAAsB,CAAC;SAClD,MAAM,CAAC,iBAAiB,EAAE,oCAAoC,CAAC;SAC/D,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAE7B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpC,OAAO,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC;IAErD,kBAAkB;IAClB,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAE9C,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/commands/auth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAsB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAShD;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,sCAAsC,CAAC;AAChD,CAAC;AAcD;;;GAGG;AACH,SAAS,eAAe,CAAC,KAAY;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACnD,OAAO,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,WAAW,CAAC,MAAqB;IAC9C,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAK,CAAC,IAAI,EAAE,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,kEAAkE;QAClE,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YAC/B,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC;QACD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC7C,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YAC1D,CAAC;YACD,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YACzD,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC7D,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAgB,EAChB,MAAyB,EACzB,MAAe;IAEf,MAAM,KAAK,GAAa,CAAC,QAAQ,CAAC,CAAC;IAEnC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,yBAAyB,IAAI,CAAC,QAAQ,YAAY,CAAC,CAAC;YAC/D,KAAK,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;QAC1C,KAAK,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IAC1E,CAAC;SAAM,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CACR,oEAAoE,CACrE,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,iCAAiC;QACjC,IAAI,MAAM,EAAE,CAAC;YACX,KAAK,CAAC,IAAI,CACR,qEAAqE,CACtE,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACX,KAAK,CAAC,IAAI,CAAC,cAAc,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAyB;IAClD,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,SAAS,CAAC;QACf,wEAAwE;QACxE,8DAA8D;QAC9D,KAAK,WAAW;YACd,OAAO,QAAQ,CAAC,OAAO,CAAC;QAC1B,KAAK,YAAY;YACf,OAAO,QAAQ,CAAC,aAAa,CAAC;QAChC,KAAK,eAAe;YAClB,OAAO,QAAQ,CAAC,aAAa,CAAC;QAChC,KAAK,eAAe;YAClB,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,iBAAiB,CAAC,OAA0B;IACzD,MAAM,MAAM,GAAG,aAAa,CAAC;QAC3B,UAAU,EAAE;YACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB;KACF,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,UAAU,CAAC;YACT,OAAO,EAAE,2DAA2D;SACrE,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAEjC,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,IAAI,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB;IAC9B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtC,OAAO;SACJ,WAAW,CAAC,4CAA4C,CAAC;SACzD,MAAM,CAAC,kBAAkB,EAAE,sBAAsB,CAAC;SAClD,MAAM,CAAC,iBAAiB,EAAE,oCAAoC,CAAC;SAC/D,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAE7B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpC,OAAO,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC;IAErD,kBAAkB;IAClB,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAE9C,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-cli",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "description": "A command-line interface for Phoenix",
   "keywords": [
     "arize",
@@ -32,18 +32,18 @@
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^1.1.0",
     "commander": "^12.1.0",
-    "@arizeai/phoenix-client": "6.5.3",
-    "@arizeai/phoenix-config": "0.1.2"
+    "@arizeai/phoenix-client": "6.5.4",
+    "@arizeai/phoenix-config": "0.1.3"
   },
   "devDependencies": {
-    "@types/node": "^18.19.0",
+    "@types/node": "^22.12.0",
     "rimraf": "^6.1.3",
     "tsc-alias": "^1.8.11",
     "tsx": "^4.19.3",
-    "vitest": "^2.1.9"
+    "vitest": "^4.1.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "scripts": {
     "build": "tsc && tsc-alias && chmod 755 build/index.js",