onyx/cli

Onyx CLI

A terminal interface for chatting with your Onyx agent. Built with Go using Bubble Tea for the TUI framework.

Installation

pip install onyx-cli

Or with uv:

uv pip install onyx-cli

Setup

Run the interactive setup:

onyx-cli configure

This prompts for your Onyx server URL and API key, tests the connection, and saves config to ~/.config/onyx-cli/config.json.

Environment variables override config file values:

Variable	Required	Description
ONYX_SERVER_URL	No	Server base URL (default: https://cloud.onyx.app)
ONYX_API_KEY	Yes	API key for authentication
ONYX_PERSONA_ID	No	Default agent/persona ID

Usage

Interactive chat (default)

onyx-cli

One-shot question

onyx-cli ask "What is our company's PTO policy?"
onyx-cli ask --agent-id 5 "Summarize this topic"
onyx-cli ask --json "Hello"

Flag	Description
--agent-id <int>	Agent ID to use (overrides default)
--json	Output raw NDJSON events instead of plain text

List agents

onyx-cli agents
onyx-cli agents --json

Serve over SSH

# Start a public SSH endpoint for the CLI TUI
onyx-cli serve --host 0.0.0.0 --port 2222

# Connect as a client
ssh your-host -p 2222

Clients can either:

• paste an API key at the login prompt, or
• skip the prompt by sending ONYX_API_KEY over SSH:

export ONYX_API_KEY=your-key
ssh -o SendEnv=ONYX_API_KEY your-host -p 2222

Useful hardening flags:

• --idle-timeout (default 15m)
• --max-session-timeout (default 8h)
• --rate-limit-per-minute (default 20)
• --rate-limit-burst (default 40)

Commands

Command	Description
chat	Launch the interactive chat TUI (default)
ask	Ask a one-shot question (non-interactive)
agents	List available agents
serve	Serve the interactive chat TUI over SSH
configure	Configure server URL and API key
validate-config	Validate configuration and test connection
install-skill	Install the agent skill file into a project

Slash Commands (in TUI)

Command	Description
/help	Show help message
/clear	Clear chat and start a new session
/agent	List and switch agents
/attach <path>	Attach a file to next message
/sessions	List recent chat sessions
/configure	Re-run connection setup
/connectors	Open connectors in browser
/settings	Open settings in browser
/quit	Exit Onyx CLI

Keyboard Shortcuts

Key	Action
Enter	Send message
Escape	Cancel current generation
Ctrl+O	Toggle source citations
Ctrl+D	Quit (press twice)
Scroll / Shift+Up/Down	Scroll chat history
Page Up / Page Down	Scroll half page

Building from Source

Requires Go 1.24+.

cd cli
go build -o onyx-cli .

Development

# Run tests
go test ./...

# Build
go build -o onyx-cli .

# Lint
staticcheck ./...

Publishing to PyPI

The CLI is distributed as a Python package via PyPI. The build system uses hatchling with manygo to cross-compile Go binaries into platform-specific wheels.

CI release (recommended)

Tag a release and push — the release-cli.yml workflow builds wheels for all platforms and publishes to PyPI automatically:

tag --prefix cli

To do this manually:

git tag cli/v0.1.0
git push origin cli/v0.1.0

The workflow builds wheels for: linux/amd64, linux/arm64, darwin/amd64, darwin/arm64, windows/amd64, windows/arm64.

Manual release

Build a wheel locally with uv. Set GOOS and GOARCH to cross-compile for other platforms (Go handles this natively — no cross-compiler needed):

# Build for current platform
uv build --wheel

# Cross-compile for a different platform
GOOS=linux GOARCH=amd64 uv build --wheel

# Upload to PyPI
uv publish

Versioning

Versions are derived from git tags with the cli/ prefix (e.g. cli/v0.1.0). The tag is parsed by internal/_version.py and injected into the Go binary via -ldflags at build time.