@arizeai/phoenix-cli 1.5.3 → 1.6.1

package/build/pxi/types.d.ts

@@ -0,0 +1,123 @@
+import type { ChatTransport, UIMessage } from "ai";
+import type { PhoenixConfig } from "../config.js";
+/**
+ * Shared types for the PXI terminal chat.
+ *
+ * These mirror the wire contract of the Phoenix server-agent chat endpoint so
+ * the CLI and the server stay in lockstep: the CLI sends a {@link PxiChatRequest}
+ * and renders the streamed {@link PxiMessage}s it gets back.
+ */
+/**
+ * Extra metadata the server attaches to each assistant message — the session it
+ * belongs to, the Phoenix trace it produced (so the UI can link back to it), and
+ * token usage. Fields are nullable because tracing and usage reporting are
+ * optional and may be disabled server-side.
+ */
+export type AssistantMessageMetadata = {
+    sessionId: string;
+    trace?: {
+        traceId: string;
+        rootSpanId: string;
+    } | null;
+    usage?: {
+        tokens: {
+            prompt: number;
+            completion: number;
+            total: number;
+        };
+        promptDetails?: {
+            cacheRead: number;
+            cacheWrite: number;
+        } | null;
+    } | null;
+};
+/** A chat message (user or assistant) carrying PXI-specific metadata. */
+export type PxiMessage = UIMessage<AssistantMessageMetadata>;
+export type BuiltInProvider = "ANTHROPIC" | "AWS" | "AZURE_OPENAI" | "CEREBRAS" | "DEEPSEEK" | "FIREWORKS" | "GOOGLE" | "GROQ" | "MOONSHOT" | "OLLAMA" | "OPENAI" | "PERPLEXITY" | "TOGETHER" | "XAI";
+/**
+ * Which model PXI should talk to. Either a built-in provider keyed by name
+ * (e.g. `ANTHROPIC` + `claude-opus-4-6`) or a custom provider configured in
+ * Phoenix and addressed by its server-side id.
+ */
+export type ModelSelection = {
+    providerType: "builtin";
+    provider: BuiltInProvider;
+    modelName: string;
+} | {
+    providerType: "custom";
+    providerId: string;
+    modelName: string;
+};
+/**
+ * A capability/environment hint sent alongside the conversation so the server
+ * agent knows what it is allowed to do and the world it is operating in — the
+ * caller's local clock and time zone, whether GraphQL mutations are permitted,
+ * and whether web access and subagents are enabled for this run.
+ */
+export type PxiContext = {
+    type: "app";
+    currentDateTime: string;
+    timeZone: string;
+} | {
+    type: "graphql";
+    mutationsEnabled: boolean;
+} | {
+    type: "web_access";
+    enabled: boolean;
+} | {
+    type: "subagents";
+    enabled: boolean;
+};
+/**
+ * How edit-style tool calls are gated: `"manual"` requires the user to approve
+ * each one, `"bypass"` lets them run unattended (where the server supports it).
+ */
+export type PxiEditPermission = "manual" | "bypass";
+/** The request body POSTed to the Phoenix server-agent chat endpoint. */
+export type PxiChatRequest = {
+    id: string;
+    messages: PxiMessage[];
+    trigger: "submit-message";
+    ingestTraces: boolean;
+    exportRemoteTraces: boolean;
+    attachUserId: boolean;
+    editPermission: PxiEditPermission;
+    contexts: PxiContext[];
+    model: ModelSelection;
+};
+/**
+ * The fully-resolved configuration for a single PXI session, produced by
+ * merging CLI flags, the active profile, and defaults. Everything the UI and
+ * client need to run is captured here, so the rest of the code can treat it as
+ * the single source of truth rather than re-reading flags or config.
+ */
+export type PxiRuntimeOptions = {
+    sessionId: string;
+    config: PhoenixConfig;
+    modelSelection: ModelSelection;
+    skipModelPreflight: boolean;
+    enableWebAccess: boolean;
+    enableSubagents: boolean;
+    enableGraphqlMutations: boolean;
+    editPermission: PxiEditPermission;
+    ingestTraces: boolean;
+    exportRemoteTraces: boolean;
+    attachUserId: boolean;
+};
+/**
+ * The interface the UI uses to talk to PXI. `sendMessage` streams an assistant
+ * reply: `onAssistantMessage` fires on every incremental update so the UI can
+ * re-render mid-stream, and the promise resolves with the final message (or
+ * `null` if nothing was produced). Defining this as an interface lets tests
+ * swap in a fake client without a real network transport.
+ */
+export type PxiChatClient = {
+    sendMessage: (options: {
+        messages: PxiMessage[];
+        abortSignal?: AbortSignal;
+        onAssistantMessage: (message: PxiMessage) => void;
+    }) => Promise<PxiMessage | null>;
+};
+/** The AI SDK chat transport specialized to {@link PxiMessage}. */
+export type PxiTransport = ChatTransport<PxiMessage>;
+//# sourceMappingURL=types.d.ts.map

package/build/pxi/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/pxi/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI,CAAC;IACT,KAAK,CAAC,EAAE;QACN,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;QACF,aAAa,CAAC,EAAE;YACd,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,EAAE,MAAM,CAAC;SACpB,GAAG,IAAI,CAAC;KACV,GAAG,IAAI,CAAC;CACV,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;AAE7D,MAAM,MAAM,eAAe,GACvB,WAAW,GACX,KAAK,GACL,cAAc,GACd,UAAU,GACV,UAAU,GACV,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB;IACE,YAAY,EAAE,SAAS,CAAC;IACxB,QAAQ,EAAE,eAAe,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB,GACD;IACE,YAAY,EAAE,QAAQ,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,gBAAgB,EAAE,OAAO,CAAC;CAC3B,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEpD,yEAAyE;AACzE,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,iBAAiB,CAAC;IAClC,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,KAAK,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,cAAc,EAAE,iBAAiB,CAAC;IAClC,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,OAAO,EAAE;QACrB,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvB,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,kBAAkB,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,IAAI,CAAC;KACnD,KAAK,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;CAClC,CAAC;AAEF,mEAAmE;AACnE,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC"}

package/build/pxi/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/pxi/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/pxi/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-cli",
-  "version": "1.5.3",
+  "version": "1.6.1",
   "description": "A command-line interface for Phoenix",
   "keywords": [
     "arize",
@@ -20,7 +20,8 @@
   },
   "bin": {
     "phoenix-cli": "build/index.js",
-    "px": "build/index.js"
+    "px": "build/index.js",
+    "pxi": "build/pxi/index.js"
   },
   "files": [
     "build",
@@ -31,14 +32,21 @@
   "types": "build/index.d.ts",
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^2.5.0",
-    "@clack/prompts": "^1.5.1",
+    "@clack/prompts": "^1.6.0",
+    "ai": "^6.0.211",
     "commander": "^15.0.0",
+    "ink": "^6.8.0",
+    "marked": "^12.0.2",
+    "marked-terminal": "^7.3.0",
+    "react": "19.2.7",
     "zod": "^4.4.3",
-    "@arizeai/phoenix-client": "6.11.1",
+    "@arizeai/phoenix-client": "6.11.2",
     "@arizeai/phoenix-config": "0.1.4"
   },
   "devDependencies": {
     "@types/node": "^25.9.4",
+    "@types/react": "19.2.17",
+    "ink-testing-library": "^4.0.0",
     "rimraf": "^6.1.3",
     "tsc-alias": "^1.8.17",
     "tsx": "^4.22.4",
@@ -48,10 +56,11 @@
     "node": ">=20"
   },
   "scripts": {
-    "build": "pnpm run build:schema && tsc && tsc-alias && chmod 755 build/index.js",
+    "build": "pnpm run build:schema && tsc && tsc-alias && chmod 755 build/index.js build/pxi/index.js",
     "build:schema": "tsx scripts/build-schema.ts && cd ../../.. && js/node_modules/.bin/oxfmt --config .oxfmtrc.jsonc schemas/phoenix-cli-settings.json",
     "clean": "rimraf build",
     "dev": "tsx src/index.ts",
+    "dev:pxi": "tsx src/pxi/index.tsx",
     "prebuild": "pnpm run clean",
     "test": "vitest run",
     "test:watch": "vitest watch",