@arizeai/phoenix-cli 1.5.2 → 1.6.0

package/build/pxi/preflight.js

@@ -0,0 +1,215 @@
+import { buildGraphqlRequest } from "../commands/api.js";
+import { InvalidArgumentError } from "../exitCodes.js";
+/**
+ * Pre-launch validation of the selected model.
+ *
+ * Before the chat UI opens, PXI asks the Phoenix server which providers and
+ * models are actually installed and credentialed, then checks the user's
+ * `--provider`/`--model` selection against that catalog. Catching a bad or
+ * unconfigured model here turns what would be a cryptic mid-stream failure into
+ * a clear, actionable startup error. The whole check can be skipped with
+ * `--skip-model-preflight`.
+ */
+/** GraphQL query fetching the server's provider catalog, credential state, and known models. */
+export const PXI_MODEL_PREFLIGHT_QUERY = /* GraphQL */ `
+  query PxiModelPreflightQuery {
+    modelProviders {
+      key
+      name
+      dependenciesInstalled
+      credentialsSet
+      credentialRequirements {
+        envVarName
+        isRequired
+      }
+    }
+    playgroundModels {
+      providerKey
+      name
+    }
+    generativeModelCustomProviders(first: 50) {
+      edges {
+        node {
+          id
+          name
+          sdk
+          modelNames
+        }
+      }
+    }
+  }
+`;
+/**
+ * Render a list of values for an error message, capping it at `limit` and
+ * summarizing the overflow as "…, and N more" so messages stay readable when a
+ * provider exposes many models.
+ */
+function formatList({ values, limit = 8, }) {
+    if (values.length === 0) {
+        return "none";
+    }
+    const visibleValues = values.slice(0, limit);
+    const remainingCount = values.length - visibleValues.length;
+    if (remainingCount <= 0) {
+        return visibleValues.join(", ");
+    }
+    return `${visibleValues.join(", ")}, and ${remainingCount} more`;
+}
+function getModelLabel({ modelSelection, }) {
+    if (modelSelection.providerType === "custom") {
+        return `custom:${modelSelection.providerId}/${modelSelection.modelName}`;
+    }
+    return `${modelSelection.provider}/${modelSelection.modelName}`;
+}
+/**
+ * Compose the "missing credentials" error for a provider, listing the required
+ * environment variables (falling back to all known ones if none are flagged
+ * required) and clarifying that these are server-side provider credentials, not
+ * the PXI CLI `--api-key`.
+ */
+function buildServerCredentialMessage({ provider, }) {
+    const requiredEnvVars = provider.credentialRequirements
+        .filter((requirement) => requirement.isRequired)
+        .map((requirement) => requirement.envVarName);
+    const envVars = requiredEnvVars.length > 0
+        ? requiredEnvVars
+        : provider.credentialRequirements.map((requirement) => requirement.envVarName);
+    return [
+        `Missing credentials for ${provider.name} (${provider.key}).`,
+        `Required server credential variables/secrets: ${formatList({
+            values: envVars,
+        })}.`,
+        "Configure credentials in Phoenix Settings > AI Providers, or set the required environment variables on the Phoenix server.",
+        "These are Phoenix server-side provider credentials, not the PXI CLI --api-key.",
+    ].join(" ");
+}
+function getCustomProviders({ data, }) {
+    return data.generativeModelCustomProviders.edges.map((edge) => edge.node);
+}
+async function readResponseText({ response, }) {
+    try {
+        return await response.text();
+    }
+    catch {
+        return "";
+    }
+}
+/**
+ * Unwrap a GraphQL response into its `data`, throwing a descriptive error if the
+ * server returned GraphQL errors or no data at all. Error messages point at
+ * `--skip-model-preflight` as the escape hatch.
+ */
+function assertPreflightData({ payload, }) {
+    const errors = payload.errors
+        ?.map((error) => error.message)
+        .filter((message) => Boolean(message));
+    if (errors && errors.length > 0) {
+        throw new Error(`Could not validate PXI model selection because Phoenix returned GraphQL errors: ${errors.join("; ")}. Use --skip-model-preflight to bypass this startup check.`);
+    }
+    if (!payload.data) {
+        throw new Error("Could not validate PXI model selection because Phoenix returned no GraphQL data. Use --skip-model-preflight to bypass this startup check.");
+    }
+    return payload.data;
+}
+/**
+ * Fetch the provider/model catalog from Phoenix via GraphQL. Requires a
+ * configured endpoint and turns non-2xx responses into errors that include the
+ * HTTP status and any response body. `fetchImpl` is injectable for testing.
+ */
+export async function fetchPxiModelPreflight({ config, fetchImpl = globalThis.fetch, }) {
+    if (!config.endpoint) {
+        throw new InvalidArgumentError("Phoenix endpoint not configured. Set PHOENIX_HOST or pass --endpoint.");
+    }
+    const request = buildGraphqlRequest({
+        query: PXI_MODEL_PREFLIGHT_QUERY,
+        config,
+    });
+    const response = await fetchImpl(request.url, {
+        method: request.method,
+        headers: request.headers,
+        body: request.body,
+    });
+    if (!response.ok) {
+        const detail = await readResponseText({ response });
+        const detailText = detail ? `: ${detail}` : "";
+        throw new Error(`Could not validate PXI model selection: HTTP ${response.status} ${response.statusText} from ${request.url}${detailText}. Use --skip-model-preflight to bypass this startup check.`);
+    }
+    const payload = (await response.json());
+    return assertPreflightData({ payload });
+}
+/**
+ * Check a model selection against the fetched catalog, throwing
+ * {@link InvalidArgumentError} with a helpful message on the first problem.
+ *
+ * For custom providers: the provider id must exist, and the model must be one of
+ * its configured names (when it advertises any). For built-in providers: the
+ * provider must be available, have its dependencies installed and credentials
+ * set, and — if the server publishes a model catalog for it — the model must be
+ * in that catalog. A provider with no published catalog accepts any model name.
+ */
+export function validatePxiModelSelection({ data, modelSelection, }) {
+    if (modelSelection.providerType === "custom") {
+        const customProviders = getCustomProviders({ data });
+        const provider = customProviders.find((candidate) => candidate.id === modelSelection.providerId);
+        if (!provider) {
+            throw new InvalidArgumentError(`Custom provider ${modelSelection.providerId} was not found on this Phoenix server. Configure it in Phoenix Settings > AI Providers or pass --skip-model-preflight. Available custom provider IDs: ${formatList({ values: customProviders.map((candidate) => candidate.id) })}.`);
+        }
+        if (provider.modelNames.length > 0 &&
+            !provider.modelNames.includes(modelSelection.modelName)) {
+            throw new InvalidArgumentError(`Invalid model for custom provider ${provider.name} (${provider.id}): ${modelSelection.modelName}. Configured model names: ${formatList({ values: provider.modelNames })}.`);
+        }
+        return;
+    }
+    const provider = data.modelProviders.find((candidate) => candidate.key === modelSelection.provider);
+    const availableProviderKeys = data.modelProviders.map((candidate) => candidate.key);
+    if (!provider) {
+        throw new InvalidArgumentError(`Provider ${modelSelection.provider} is not available on this Phoenix server. Available providers: ${formatList({ values: availableProviderKeys })}.`);
+    }
+    if (!provider.dependenciesInstalled) {
+        throw new InvalidArgumentError(`${provider.name} (${provider.key}) is unavailable because the Phoenix server does not have that provider installed. Install the provider dependencies on the Phoenix server or choose another provider.`);
+    }
+    if (provider.credentialRequirements.length > 0 && !provider.credentialsSet) {
+        throw new InvalidArgumentError(buildServerCredentialMessage({ provider }));
+    }
+    const providerModels = data.playgroundModels
+        .filter((model) => model.providerKey === modelSelection.provider)
+        .map((model) => model.name);
+    const hasProviderCatalog = providerModels.length > 0;
+    const isKnownModel = providerModels.includes(modelSelection.modelName);
+    if (hasProviderCatalog && !isKnownModel) {
+        throw new InvalidArgumentError(`Invalid model for ${provider.name} (${provider.key}): ${modelSelection.modelName}. Available models for this provider include: ${formatList({ values: providerModels })}.`);
+    }
+}
+/**
+ * Run the full preflight for a session: fetch the catalog and validate the
+ * selected model, unless `--skip-model-preflight` was passed. This is the single
+ * call the entry point makes before rendering the UI.
+ */
+export async function runPxiModelPreflight({ options, fetchImpl = globalThis.fetch, }) {
+    if (options.skipModelPreflight) {
+        return;
+    }
+    const data = await fetchPxiModelPreflight({
+        config: options.config,
+        fetchImpl,
+    });
+    validatePxiModelSelection({
+        data,
+        modelSelection: options.modelSelection,
+    });
+}
+/**
+ * Wrap an error thrown while talking to PXI into a single message that names the
+ * model and appends a tailored next step — pointing custom providers at their
+ * Phoenix settings and built-in providers at credential configuration or
+ * choosing a different model. Used for failures that surface after the preflight
+ * has already passed.
+ */
+export function formatPxiRuntimeError({ error, modelSelection, }) {
+    const message = error instanceof Error ? error.message : String(error);
+    const nextAction = modelSelection.providerType === "custom"
+        ? "Check the custom provider configuration in Phoenix Settings > AI Providers."
+        : `Configure ${modelSelection.provider} credentials in Phoenix Settings > AI Providers, set the required environment variables on the Phoenix server, or choose a different model.`;
+    return new Error(`PXI request failed for ${getModelLabel({ modelSelection })}: ${message} ${nextAction}`);
+}
+//# sourceMappingURL=preflight.js.map

package/build/pxi/preflight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preflight.js","sourceRoot":"","sources":["../../src/pxi/preflight.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAGpD;;;;;;;;;GASG;AAEH,gGAAgG;AAChG,MAAM,CAAC,MAAM,yBAAyB,GAAG,aAAa,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BtD,CAAC;AA4CF;;;;GAIG;AACH,SAAS,UAAU,CAAC,EAClB,MAAM,EACN,KAAK,GAAG,CAAC,GAIV;IACC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;IAC5D,IAAI,cAAc,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,cAAc,OAAO,CAAC;AACnE,CAAC;AAED,SAAS,aAAa,CAAC,EACrB,cAAc,GAGf;IACC,IAAI,cAAc,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC7C,OAAO,UAAU,cAAc,CAAC,UAAU,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;IAC3E,CAAC;IACD,OAAO,GAAG,cAAc,CAAC,QAAQ,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;AAClE,CAAC;AAED;;;;;GAKG;AACH,SAAS,4BAA4B,CAAC,EACpC,QAAQ,GAGT;IACC,MAAM,eAAe,GAAG,QAAQ,CAAC,sBAAsB;SACpD,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC;SAC/C,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAChD,MAAM,OAAO,GACX,eAAe,CAAC,MAAM,GAAG,CAAC;QACxB,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,GAAG,CACjC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CACxC,CAAC;IACR,OAAO;QACL,2BAA2B,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,IAAI;QAC7D,iDAAiD,UAAU,CAAC;YAC1D,MAAM,EAAE,OAAO;SAChB,CAAC,GAAG;QACL,4HAA4H;QAC5H,gFAAgF;KACjF,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACd,CAAC;AAED,SAAS,kBAAkB,CAAC,EAC1B,IAAI,GAGL;IACC,OAAO,IAAI,CAAC,8BAA8B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5E,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,EAC9B,QAAQ,GAGT;IACC,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,EAC3B,OAAO,GAGR;IACC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;QAC3B,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;SAC9B,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5D,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,mFAAmF,MAAM,CAAC,IAAI,CAC5F,IAAI,CACL,4DAA4D,CAC9D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,2IAA2I,CAC5I,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,EAC3C,MAAM,EACN,SAAS,GAAG,UAAU,CAAC,KAAK,GAI7B;IACC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,IAAI,oBAAoB,CAC5B,uEAAuE,CACxE,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,mBAAmB,CAAC;QAClC,KAAK,EAAE,yBAAyB;QAChC,MAAM;KACP,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE;QAC5C,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CACb,gDAAgD,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,SAAS,OAAO,CAAC,GAAG,GAAG,UAAU,4DAA4D,CACpL,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GACX,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA2C,CAAC;IACpE,OAAO,mBAAmB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,yBAAyB,CAAC,EACxC,IAAI,EACJ,cAAc,GAIf;IACC,IAAI,cAAc,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC7C,MAAM,eAAe,GAAG,kBAAkB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CACnC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,cAAc,CAAC,UAAU,CAC1D,CAAC;QACF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,oBAAoB,CAC5B,mBAAmB,cAAc,CAAC,UAAU,yJAAyJ,UAAU,CAC7M,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAC7D,GAAG,CACL,CAAC;QACJ,CAAC;QACD,IACE,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAC9B,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,EACvD,CAAC;YACD,MAAM,IAAI,oBAAoB,CAC5B,qCAAqC,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,MAAM,cAAc,CAAC,SAAS,6BAA6B,UAAU,CACrI,EAAE,MAAM,EAAE,QAAQ,CAAC,UAAU,EAAE,CAChC,GAAG,CACL,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CACvC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,cAAc,CAAC,QAAQ,CACzD,CAAC;IACF,MAAM,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CACnD,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAC7B,CAAC;IACF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,oBAAoB,CAC5B,YAAY,cAAc,CAAC,QAAQ,kEAAkE,UAAU,CAC7G,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAClC,GAAG,CACL,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAC;QACpC,MAAM,IAAI,oBAAoB,CAC5B,GAAG,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,wKAAwK,CAC1M,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QAC3E,MAAM,IAAI,oBAAoB,CAAC,4BAA4B,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB;SACzC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,KAAK,cAAc,CAAC,QAAQ,CAAC;SAChE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,kBAAkB,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,MAAM,YAAY,GAAG,cAAc,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACvE,IAAI,kBAAkB,IAAI,CAAC,YAAY,EAAE,CAAC;QACxC,MAAM,IAAI,oBAAoB,CAC5B,qBAAqB,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,MAAM,cAAc,CAAC,SAAS,iDAAiD,UAAU,CAC1I,EAAE,MAAM,EAAE,cAAc,EAAE,CAC3B,GAAG,CACL,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,EACzC,OAAO,EACP,SAAS,GAAG,UAAU,CAAC,KAAK,GAI7B;IACC,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QAC/B,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;QACxC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS;KACV,CAAC,CAAC;IACH,yBAAyB,CAAC;QACxB,IAAI;QACJ,cAAc,EAAE,OAAO,CAAC,cAAc;KACvC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,EACpC,KAAK,EACL,cAAc,GAIf;IACC,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,MAAM,UAAU,GACd,cAAc,CAAC,YAAY,KAAK,QAAQ;QACtC,CAAC,CAAC,6EAA6E;QAC/E,CAAC,CAAC,aAAa,cAAc,CAAC,QAAQ,6IAA6I,CAAC;IACxL,OAAO,IAAI,KAAK,CACd,0BAA0B,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC,KAAK,OAAO,IAAI,UAAU,EAAE,CACxF,CAAC;AACJ,CAAC"}

package/build/pxi/toolProgress.d.ts

@@ -0,0 +1,37 @@
+import type { UIDataTypes, UIMessagePart, UITools } from "ai";
+import type { PxiMessage } from "./types.js";
+/**
+ * Distills the AI SDK's tool-call message parts into a small, display-ready
+ * {@link ToolProgress} shape the UI can render directly. The SDK models a tool
+ * call as a sequence of parts moving through lifecycle states; this module reads
+ * the current state and produces a human-readable status line plus an optional
+ * one-line summary of the tool's input or output.
+ */
+/** Lifecycle state of a single tool call, mirroring the AI SDK's part states. */
+export type ToolProgressState = "input-streaming" | "input-available" | "approval-requested" | "approval-responded" | "output-available" | "output-error" | "output-denied";
+/** A display-ready summary of one tool call's current progress. */
+export type ToolProgress = {
+    toolCallId: string;
+    toolName: string;
+    state: ToolProgressState;
+    statusText: string;
+    errorText?: string;
+};
+/**
+ * Collect the progress of every tool call across a list of messages, in order,
+ * skipping non-tool parts.
+ */
+export declare function getToolProgressFromMessages(messages: readonly PxiMessage[]): ToolProgress[];
+/**
+ * Convert a single message part into a {@link ToolProgress}, or `null` if the
+ * part isn't a tool call. This is the core mapping that derives the tool name,
+ * status label, detail summary, and any error text from the raw SDK part.
+ */
+export declare function getToolProgressFromPart({ part, }: {
+    part: UIMessagePart<UIDataTypes, UITools>;
+}): ToolProgress | null;
+/** Concatenate the text of all text parts in a message, ignoring tool parts. */
+export declare function getMessageText({ message }: {
+    message: PxiMessage;
+}): string;
+//# sourceMappingURL=toolProgress.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"toolProgress.d.ts","sourceRoot":"","sources":["../../src/pxi/toolProgress.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAE9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;;;GAMG;AAEH,iFAAiF;AACjF,MAAM,MAAM,iBAAiB,GACzB,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,mEAAmE;AACnE,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,iBAAiB,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAoDF;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,SAAS,UAAU,EAAE,GAC9B,YAAY,EAAE,CAOhB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,IAAI,GACL,EAAE;IACD,IAAI,EAAE,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;CAC3C,GAAG,YAAY,GAAG,IAAI,CAatB;AAED,gFAAgF;AAChF,wBAAgB,cAAc,CAAC,EAAE,OAAO,EAAE,EAAE;IAAE,OAAO,EAAE,UAAU,CAAA;CAAE,GAAG,MAAM,CAK3E"}

package/build/pxi/toolProgress.js

@@ -0,0 +1,71 @@
+/**
+ * Type guard recognizing the message parts that represent a tool call — both
+ * statically-typed (`tool-*`) and dynamic tools — so non-tool parts (like text)
+ * are skipped.
+ */
+function isPxiToolPart(part) {
+    return ("toolCallId" in part &&
+        "state" in part &&
+        (part.type === "dynamic-tool" || part.type.startsWith("tool-")));
+}
+function getToolName(part) {
+    return part.type === "dynamic-tool"
+        ? (part.toolName ?? "dynamic-tool")
+        : part.type.replace(/^tool-/, "");
+}
+/** Map a lifecycle state to the short human-readable label shown to the user. */
+function getStatusText(state) {
+    switch (state) {
+        case "input-streaming":
+            return "Preparing";
+        case "input-available":
+            return "Running";
+        case "approval-requested":
+            return "Awaiting approval";
+        case "approval-responded":
+            return "Approval recorded";
+        case "output-available":
+            return "Complete";
+        case "output-error":
+            return "Failed";
+        case "output-denied":
+            return "Denied";
+    }
+}
+/**
+ * Collect the progress of every tool call across a list of messages, in order,
+ * skipping non-tool parts.
+ */
+export function getToolProgressFromMessages(messages) {
+    return messages.flatMap((message) => message.parts.flatMap((part) => {
+        const toolProgress = getToolProgressFromPart({ part });
+        return toolProgress ? [toolProgress] : [];
+    }));
+}
+/**
+ * Convert a single message part into a {@link ToolProgress}, or `null` if the
+ * part isn't a tool call. This is the core mapping that derives the tool name,
+ * status label, detail summary, and any error text from the raw SDK part.
+ */
+export function getToolProgressFromPart({ part, }) {
+    if (!isPxiToolPart(part)) {
+        return null;
+    }
+    const toolName = getToolName(part);
+    const state = part.state;
+    return {
+        toolCallId: part.toolCallId,
+        toolName,
+        state,
+        statusText: getStatusText(state),
+        errorText: "errorText" in part ? part.errorText : undefined,
+    };
+}
+/** Concatenate the text of all text parts in a message, ignoring tool parts. */
+export function getMessageText({ message }) {
+    return message.parts
+        .filter((part) => part.type === "text")
+        .map((part) => part.text)
+        .join("");
+}
+//# sourceMappingURL=toolProgress.js.map

package/build/pxi/toolProgress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolProgress.js","sourceRoot":"","sources":["../../src/pxi/toolProgress.ts"],"names":[],"mappings":"AAwCA;;;;GAIG;AACH,SAAS,aAAa,CACpB,IAAyC;IAEzC,OAAO,CACL,YAAY,IAAI,IAAI;QACpB,OAAO,IAAI,IAAI;QACf,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAChE,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,IAAiB;IACpC,OAAO,IAAI,CAAC,IAAI,KAAK,cAAc;QACjC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,cAAc,CAAC;QACnC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,iFAAiF;AACjF,SAAS,aAAa,CAAC,KAAwB;IAC7C,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,iBAAiB;YACpB,OAAO,WAAW,CAAC;QACrB,KAAK,iBAAiB;YACpB,OAAO,SAAS,CAAC;QACnB,KAAK,oBAAoB;YACvB,OAAO,mBAAmB,CAAC;QAC7B,KAAK,oBAAoB;YACvB,OAAO,mBAAmB,CAAC;QAC7B,KAAK,kBAAkB;YACrB,OAAO,UAAU,CAAC;QACpB,KAAK,cAAc;YACjB,OAAO,QAAQ,CAAC;QAClB,KAAK,eAAe;YAClB,OAAO,QAAQ,CAAC;IACpB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CACzC,QAA+B;IAE/B,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAClC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,MAAM,YAAY,GAAG,uBAAuB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,IAAI,GAGL;IACC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,OAAO;QACL,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,QAAQ;QACR,KAAK;QACL,UAAU,EAAE,aAAa,CAAC,KAAK,CAAC;QAChC,SAAS,EAAE,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;KAC5D,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,cAAc,CAAC,EAAE,OAAO,EAA2B;IACjE,OAAO,OAAO,CAAC,KAAK;SACjB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC;SACtC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;SACxB,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC"}

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.2",
+  "version": "1.6.0",
   "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",
@@ -32,13 +33,20 @@
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^2.5.0",
     "@clack/prompts": "^1.5.1",
+    "ai": "^6.0.208",
     "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.0",
+    "@arizeai/phoenix-client": "6.11.1",
     "@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",