Riven
Riven TUI

Configuration

Environment variables for connecting the Riven TUI to a Riven instance

The TUI is configured entirely through environment variables, validated at startup by a Zod schema (lib/riven-tui-settings.schema.ts). If a required value is missing or invalid, the TUI exits immediately with a validation error instead of starting in a broken state.

Variables

VariableDescriptionDefault
RIVEN_TUI_SETTING__graphqlUrlThe GraphQL endpoint of the Riven instance to connect to.http://localhost:3000/graphql
RIVEN_TUI_SETTING__enableDebugEnables debug output.false

Setting variables

When running from source with pnpm --filter @repo/riven-tui dev or start, the TUI automatically loads a .env.riven-tui file from the app directory if one exists. Copy the provided example to get started:

cp apps/riven-tui/.env.riven-tui.example apps/riven-tui/.env.riven-tui
.env.riven-tui
RIVEN_TUI_SETTING__graphqlUrl="http://localhost:3000/graphql"
RIVEN_TUI_SETTING__enableDebug="false"

When running inside the Riven Docker container (see Getting Started), set the variables directly in the docker exec invocation or the container's environment, since the TUI shares the container with the Riven process it's inspecting:

docker exec -it -e RIVEN_TUI_SETTING__graphqlUrl="http://localhost:3000/graphql" \
  <riven-container> node tui/dist/cli.js

Because the TUI talks to Riven purely over HTTP, RIVEN_TUI_SETTING__graphqlUrl can point at any reachable Riven instance - it doesn't need to run on the same host or in the same container.

On this page