Skip to content

ChatGPT in your terminal: slash commands, any OpenAI model, local tools, fast and beautiful TUI

Notifications You must be signed in to change notification settings

WilliamAGH/brief

Repository files navigation

Context7 DeepWiki

Brief

A terminal ChatGPT client for fast, keyboard-first chat. Includes slash commands, tool execution, and support for OpenAI-compatible providers.

Brief screenshot

Built with TUI4J — a Java port of Bubble Tea. Location features powered by Apple Maps Java.

Apple Maps in Brief

Quick Start

Homebrew (macOS)

brew install williamagh/tap/brief
brief

The app prompts for your API key on first launch and saves it to ~/.config/brief/config.

For alternative providers (OpenRouter, Ollama, LMStudio), see the configuration guide.

GitHub Releases

Download from releases. Requires Java 25.

Development

Prerequisites

This project uses Gradle Toolchains with Temurin JDK 25 and mise (or asdf) for reproducible builds.

Option 1: Using mise (recommended)

# Install mise if you don't have it: https://mise.jdnow.dev/
mise install

Option 2: Using asdf

# Install asdf if you don't have it: https://asdf-vm.com/
asdf plugin add java https://github.com/halcyon/asdf-java.git
asdf install

What happens: Gradle Toolchains will auto-download Temurin JDK 25 on first build if not present locally. The mise/asdf setup ensures your shell and IDE use the correct Java version.

Running

git clone https://github.com/WilliamAGH/brief.git
cd brief
cp .env-example .env   # add your API key
make run

Commands: make run | make build | make clean | make dist

See docs/development.md for more details.

Contributing

Open an issue for bugs or feature requests. PRs welcome.


Made by William Callahan · Repo

Other projects I've made

About

ChatGPT in your terminal: slash commands, any OpenAI model, local tools, fast and beautiful TUI

Topics

Resources

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •