Z²ᴱ logo

Installation

Install and configure z2e-terminal.

Prerequisites

  • Go 1.26+ (check go.mod for the exact toolchain version)
  • just (recommended; recipes are canonical)
  • Git

Clone & Build

git clone https://github.com/Z2E-Agent/z2e-terminal.git
cd z2e-terminal

# Build the binary (outputs to ./bin/z2e-terminal)
just build

# Or with raw Go
go build -o bin/z2e-terminal ./cmd/z2e-terminal/

The binary is output to ./bin/z2e-terminal.

Environment Configuration

Copy the example env file and configure your OpenCode Go credentials:

cp .env.example .env

Required environment variables:

VariableDescription
AI_GATEWAY_API_KEYYour OpenCode Go API key

Optional environment variables:

VariableDefaultDescription
AI_GATEWAY_BASE_URLhttps://opencode.ai/zen/go/v1Gateway endpoint
AI_GATEWAY_MODELopencode-go/deepseek-v4-proDefault model

The gateway URL enforces HTTPS for non-loopback hosts. Plain HTTP is allowed only for localhost / 127.x.x.x / ::1 (e.g. a local Ollama-compatible gateway). Invalid URLs fall back to the default endpoint.

Verify Installation

# Start the TUI
just run

# Or directly
./bin/z2e-terminal

You should see the Z2E Terminal interface with a prompt area and status bar.

On this page