feat: show a link to the Dev UI on running evals

genkit-tools/cli/src/commands/eval-flow.ts

@@ -31,10 +31,12 @@ import {
 } from '@genkit-ai/tools-common/eval';
 import {
   confirmLlmUse,
+  getDevUiUrl,
   hasAction,
   loadInferenceDatasetFile,
   logger,
 } from '@genkit-ai/tools-common/utils';
+import * as clc from 'colorette';
 import { Command } from 'commander';
 import { runWithManager } from '../utils/manager-utils';
 
@@ -167,9 +169,18 @@ export const evalFlow = new Command('eval:flow')
           await exportFn(evalRun, options.output);
         }
 
-        console.log(
-          `Succesfully ran evaluation, with evalId: ${evalRun.key.evalRunId}`
-        );
+        const devUiUrl = await getDevUiUrl();
+        if (devUiUrl) {
+          logger.info(
+            clc.green(
+              `\nView the evaluation results at: ${devUiUrl}/evaluate/${evalRun.key.evalRunId}`
+            )
+          );
+        } else {
+          logger.info(
+            `Succesfully ran evaluation, with evalId: ${evalRun.key.evalRunId}`
+          );
+        }
       });
     }
   );

genkit-tools/cli/src/commands/eval-run.ts

@@ -24,9 +24,11 @@ import {
 } from '@genkit-ai/tools-common/eval';
 import {
   confirmLlmUse,
+  getDevUiUrl,
   loadEvaluationDatasetFile,
   logger,
 } from '@genkit-ai/tools-common/utils';
+import * as clc from 'colorette';
 import { Command } from 'commander';
 import { runWithManager } from '../utils/manager-utils';
 
@@ -113,8 +115,17 @@ export const evalRun = new Command('eval:run')
         await exportFn(evalRun, options.output);
       }
 
-      console.log(
-        `Succesfully ran evaluation, with evalId: ${evalRun.key.evalRunId}`
-      );
+      const devUiUrl = await getDevUiUrl();
+      if (devUiUrl) {
+        logger.info(
+          clc.green(
+            `\nView the evaluation results at: ${devUiUrl}/evaluate/${evalRun.key.evalRunId}`
+          )
+        );
+      } else {
+        logger.info(
+          `Succesfully ran evaluation, with evalId: ${evalRun.key.evalRunId}`
+        );
+      }
     });
   });

genkit-tools/cli/src/commands/start.ts

@@ -16,7 +16,7 @@
 
 import { RuntimeManager } from '@genkit-ai/tools-common/manager';
 import { startServer } from '@genkit-ai/tools-common/server';
-import { logger } from '@genkit-ai/tools-common/utils';
+import { logger, setDevUiUrl } from '@genkit-ai/tools-common/utils';
 import { spawn } from 'child_process';
 import { Command } from 'commander';
 import getPort, { makeRange } from 'get-port';
@@ -56,6 +56,7 @@ export const start = new Command('start')
       if (options.open) {
         open(`http://localhost:${port}`);
       }
+      await setDevUiUrl(`http://localhost:${port}`);
     }
     await managerPromise.then((manager: RuntimeManager) => {
       const telemetryServerUrl = manager?.telemetryServerUrl;

genkit-tools/cli/src/commands/ui-start.ts

@@ -15,7 +15,9 @@
  */
 
 import {
+  DevToolsInfo,
   findServersDir,
+  isValidDevToolsInfo,
   logger,
   waitUntilHealthy,
 } from '@genkit-ai/tools-common/utils';
@@ -33,24 +35,6 @@ interface StartOptions {
   open?: boolean;
 }
 
-export interface DevToolsInfo {
-  /** URL of the dev tools server. */
-  url: string;
-  /** Timestamp of when the dev tools server was started. */
-  timestamp: string;
-}
-
-/**
- * Checks if the provided data is a valid dev tools server state file.
- */
-export function isValidDevToolsInfo(data: any): data is DevToolsInfo {
-  return (
-    typeof data === 'object' &&
-    typeof data.url === 'string' &&
-    typeof data.timestamp === 'string'
-  );
-}
-
 /** Command to start the Genkit Developer UI. */
 export const uiStart = new Command('ui:start')
   .description(

genkit-tools/cli/src/commands/ui-stop.ts

@@ -15,7 +15,9 @@
  */
 
 import {
+  DevToolsInfo,
   findServersDir,
+  isValidDevToolsInfo,
   logger,
   waitUntilUnresponsive,
 } from '@genkit-ai/tools-common/utils';
@@ -24,7 +26,6 @@ import * as clc from 'colorette';
 import { Command } from 'commander';
 import fs from 'fs/promises';
 import path from 'path';
-import { DevToolsInfo, isValidDevToolsInfo } from './ui-start';
 
 /** Command to stop the Genkit Developer UI. */
 export const uiStop = new Command('ui:stop')

genkit-tools/common/src/utils/utils.ts

@@ -17,6 +17,14 @@
 import * as fs from 'fs/promises';
 import * as path from 'path';
 import { Runtime } from '../manager/types';
+import { logger } from './logger';
+
+export interface DevToolsInfo {
+  /** URL of the dev tools server. */
+  url: string;
+  /** Timestamp of when the dev tools server was started. */
+  timestamp: string;
+}
 
 /**
  * Finds the project root by looking for a `package.json` file.
@@ -215,3 +223,57 @@ export async function retriable<T>(
     attempt++;
   }
 }
+
+/**
+ * Checks if the provided data is a valid dev tools server state file.
+ */
+export function isValidDevToolsInfo(data: any): data is DevToolsInfo {
+  return (
+    typeof data === 'object' &&
+    typeof data.url === 'string' &&
+    typeof data.timestamp === 'string'
+  );
+}
+
+/**
+ * Finds the URL of the currently running Genkit Dev UI instance (if available).
+ */
+export async function getDevUiUrl(
+  projectRoot?: string
+): Promise<string | undefined> {
+  const serversDir = await findServersDir(projectRoot);
+  const toolsJsonPath = path.join(serversDir, 'tools.json');
+  try {
+    const toolsJsonContent = await fs.readFile(toolsJsonPath, 'utf-8');
+    const serverInfo = JSON.parse(toolsJsonContent) as DevToolsInfo;
+    if (isValidDevToolsInfo(serverInfo)) {
+      return (await checkServerHealth(serverInfo.url))
+        ? serverInfo.url
+        : undefined;
+    }
+  } catch (error) {
+    logger.info('Error reading tools config', error);
+    return undefined;
+  }
+}
+
+/**
+ * Sets the Genkit Dev UI URL
+ */
+export async function setDevUiUrl(
+  url: string,
+  projectRoot?: string
+): Promise<void> {
+  const serversDir = await findServersDir(projectRoot);
+  const toolsJsonPath = path.join(serversDir, 'tools.json');
+  try {
+    const serverInfo = {
+      url,
+      timestamp: new Date().toISOString(),
+    } as DevToolsInfo;
+    await fs.mkdir(serversDir, { recursive: true });
+    await fs.writeFile(toolsJsonPath, JSON.stringify(serverInfo, null, 2));
+  } catch (error) {
+    logger.info('Error writing tools config', error);
+  }
+}

js/testapps/evals/package.json

@@ -11,7 +11,7 @@
     "build:watch": "tsc --watch",
     "build-and-run": "pnpm build && node lib/index.js",
     "dev": "tsx --watch src/index.ts",
-    "genkit:dev": "genkit start -- tsx --watch src/index.ts"
+    "genkit:dev": "tsx --watch src/index.ts"
   },
   "keywords": [],
   "author": "",