@arizeai/phoenix-cli 1.3.0 → 1.3.1

package/build/settings.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Settings storage schema definitions for the Phoenix CLI.
+ *
+ * This module exports the Zod schemas and inferred TypeScript types that
+ * describe the on-disk settings file (`~/.px/settings.json`). Runtime I/O,
+ * parsing, and profile resolution logic live alongside the CLI commands
+ * that consume them; this file is the canonical source for
+ * `schemas/phoenix-cli-settings.json` (emitted by `scripts/build-schema.ts`).
+ */
+import { z } from "zod";
+export declare const ProfileEntrySchema: z.ZodObject<{
+    endpoint: z.ZodOptional<z.ZodString>;
+    apiKey: z.ZodOptional<z.ZodString>;
+    project: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export declare const SettingsFileSchema: z.ZodObject<{
+    $schema: z.ZodOptional<z.ZodString>;
+    activeProfile: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
+    profiles: z.ZodRecord<z.ZodString, z.ZodObject<{
+        endpoint: z.ZodOptional<z.ZodString>;
+        apiKey: z.ZodOptional<z.ZodString>;
+        project: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * A single named profile entry. All fields are optional — a profile may
+ * override only a subset of configuration values.
+ */
+export type ProfileEntry = z.infer<typeof ProfileEntrySchema>;
+/**
+ * On-disk schema for the CLI settings file.
+ */
+export type SettingsFile = z.infer<typeof SettingsFileSchema>;
+//# sourceMappingURL=settings.d.ts.map

package/build/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,kBAAkB;;;;;iBAyB7B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;iBAiB7B,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/build/settings.js

@@ -0,0 +1,41 @@
+/**
+ * Settings storage schema definitions for the Phoenix CLI.
+ *
+ * This module exports the Zod schemas and inferred TypeScript types that
+ * describe the on-disk settings file (`~/.px/settings.json`). Runtime I/O,
+ * parsing, and profile resolution logic live alongside the CLI commands
+ * that consume them; this file is the canonical source for
+ * `schemas/phoenix-cli-settings.json` (emitted by `scripts/build-schema.ts`).
+ */
+import { z } from "zod";
+export const ProfileEntrySchema = z.object({
+    endpoint: z
+        .string()
+        .optional()
+        .describe("Phoenix server URL this profile targets (e.g. https://app.phoenix.arize.com or http://localhost:6006)."),
+    apiKey: z
+        .string()
+        .optional()
+        .describe("API key sent as `Authorization: Bearer <apiKey>` with every request. Accepts both user and system API keys for self-hosted Phoenix and Phoenix Cloud. Treat as a secret — the profiles file should be user-readable only (mode 0600)."),
+    project: z
+        .string()
+        .optional()
+        .describe("Default Phoenix project name used when commands don't pass --project."),
+    headers: z
+        .record(z.string(), z.string())
+        .optional()
+        .describe("Extra HTTP headers sent with every request from this profile. Useful for custom auth or routing. Values override defaults."),
+});
+export const SettingsFileSchema = z.object({
+    $schema: z
+        .string()
+        .optional()
+        .describe("Optional JSON Schema URL for editor autocomplete. Pin to a GitHub raw URL at a released tag; see README."),
+    activeProfile: z
+        .union([z.string(), z.null()])
+        .describe("Name of the profile to use when no --profile flag is passed. Must match a key in `profiles`."),
+    profiles: z
+        .record(z.string(), ProfileEntrySchema)
+        .describe("Map of profile name to profile entry. Keys are the profile names referenced by `activeProfile` and the --profile flag."),
+});
+//# sourceMappingURL=settings.js.map

package/build/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,wGAAwG,CACzG;IACH,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,uOAAuO,CACxO;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,uEAAuE,CACxE;IACH,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;SAC9B,QAAQ,EAAE;SACV,QAAQ,CACP,4HAA4H,CAC7H;CACJ,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,0GAA0G,CAC3G;IACH,aAAa,EAAE,CAAC;SACb,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;SAC7B,QAAQ,CACP,8FAA8F,CAC/F;IACH,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC;SACtC,QAAQ,CACP,wHAAwH,CACzH;CACJ,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-cli",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "A command-line interface for Phoenix",
   "keywords": [
     "arize",
@@ -33,7 +33,8 @@
     "@arizeai/openinference-semantic-conventions": "^1.1.0",
     "@clack/prompts": "^1.0.1",
     "commander": "^12.1.0",
-    "@arizeai/phoenix-client": "6.8.0",
+    "zod": "^4.0.14",
+    "@arizeai/phoenix-client": "6.8.1",
     "@arizeai/phoenix-config": "0.1.3"
   },
   "devDependencies": {
@@ -47,7 +48,8 @@
     "node": ">=20"
   },
   "scripts": {
-    "build": "tsc && tsc-alias && chmod 755 build/index.js",
+    "build": "pnpm run build:schema && tsc && tsc-alias && chmod 755 build/index.js",
+    "build:schema": "tsx scripts/build-schema.ts && cd ../../.. && oxfmt --config .oxfmtrc.jsonc schemas/phoenix-cli-settings.json",
     "clean": "rimraf build",
     "dev": "tsx src/index.ts",
     "prebuild": "pnpm run clean",