Documentation

Quick Start

1. Connect the Hardware

Plug your Halo Terminal into any USB-C port on your computer. The device uses a single cable for both power and data communication.

2. Install the CLI

Install the hat CLI via npm:

$ npm install -g halo-terminal

Or download from the releases page, or build from source:

$ git clone https://github.com/f0i/halo-terminal.git
$ cd halo-terminal
$ make install

3. Configure Claude Code Integration

Run the setup command to install the hooks for Claude Code:

$ hat setup
# Configure hooks for Claude Code
✓ Hooks installed

4. Start the Service

Run the Halo service to connect to your device:

$ hat run
# Start the Halo service
✓ Connected to device

LED States

The Halo Terminal uses three distinct colors to indicate the current state of Claude Code:

CLI Commands

hat setup

Installs the Claude Code hooks that enable communication between Claude Code and the Halo Terminal.

$ hat setup

hat run

Starts the Halo service. This connects to your device and listens for state changes from Claude Code.

$ hat run

hat status

Shows the current connection status and device information.

$ hat status

hat test

Cycles through all LED states to verify your device is working correctly.

$ hat test

Technical Specifications

Troubleshooting

Device not detected

• Ensure the USB-C cable is fully connected
• Try a different USB port
• Check that you have the necessary permissions to access USB devices

LED not changing states

• Verify the hooks are installed: hat setup
• Check that the service is running: hat status
• Restart the service: hat run