Developer tools

Genkit provides two key developer tools:

• A CLI for command-line operations
• A local web app, called the Developer UI, that interfaces with your Genkit app for interactive testing and development

Install the CLI

NPM

npm install -g genkit-cli

Binary (Preview)

On macOS or Linux run:

curl -sL cli.genkit.dev | bash

On Windows download the binary from: here

More details can be found at https://cli.genkit.dev

Command line interface (CLI)

The CLI supports various commands to facilitate working with Genkit projects:

• genkit start -- <command to run your code>: Start the developer UI and connect it to a running code process.
• genkit flow:run <flowName>: Run a specified flow.
• genkit eval:flow <flowName>: Evaluate a specific flow.
• genkit trace:list: List traces.
• genkit trace:get <traceId>: Get a trace by ID.

Standalone vs separate terminals

Commands that interact with your code (such as flow:run and eval:flow) require a running Genkit process. You can run these commands against an already running process in a separate terminal, or you can run them standalone by appending -- <command to run your code>.

For example, to run a flow standalone, which starts the runtime, runs the flow, and exits:

genkit flow:run myFlow -- npx tsx src/index.ts

For a full list of commands, use:

genkit --help

Genkit Developer UI

The Genkit Developer UI is a local web app that lets you interactively work with models, flows, prompts, and other elements in your Genkit project.

The Developer UI is able to identify what Genkit components you have defined in your code by attaching to a running code process.

To start the UI, run the following command:

genkit start -- <command to run your code>

The <command to run your code> will vary based on your project’s setup and the file you want to execute. Here are some examples: