Docs track: Current (v0.1). Versioned docs planned.

Quickstart Guide

Get up and running with terminaI in 5 minutes.

Installation

From Source (Recommended)

# From the repo root
npm ci
npm run build
npm link --workspace packages/termai

# Run it
terminai

Optional: Add gemini Alias

For muscle memory compatibility:

./scripts/termai-install.sh --alias-gemini

Authentication

terminaI uses Google OAuth (browser flow) or an API key for model access.

Option 1: Login with Google (Recommended)

terminai
# Follow the browser authentication flow

Option 2: API Key

export GEMINI_API_KEY="YOUR_API_KEY"
terminai

First Commands

Interactive Mode

terminai
> What's eating my CPU right now?
> How much disk space do I have?
> Start the dev server and watch logs

Slash Commands

  • /help - Show available commands
  • /sessions - List background processes
  • /exit - Exit terminaI

Next Steps

Optional: Run the Desktop App (Tauri)

The Desktop app is an A2A client (it does not spawn the CLI).

npm -w packages/desktop dev

In the Desktop app, set:

  • Agent URL: the A2A server URL (e.g. http://127.0.0.1:41242)
  • Token: the web-remote token printed by the CLI (see Web Remote guide)