Reference

Reference

Complete reference documentation for Trellis.

Configuration

Full documentation for the trellis.hjson configuration file, including:

• Project and server settings
• Service definitions
• Worktree configuration
• Terminal settings
• Workflow definitions
• Log viewer configuration
• Crash reporting options

trellis-ctl

Command-line interface reference:

• Service commands (status, start, stop, restart)
• Log commands (view, filter, stream)
• Workflow commands (list, run, status)
• Worktree commands (list, activate)
• Crash commands (list, newest, delete)
• Trace commands

Go Client Library

Official Go client library (pkg/client) for programmatic access:

• Typed access to all API endpoints
• API versioning support
• Sub-clients for Services, Worktrees, Workflows, Events, Logs, Trace, Notify

Keyboard Shortcuts

Quick navigation and control in the web interface:

• Navigation picker (Cmd+P)
• History picker (Cmd+Backspace)
• Editor toggle (Cmd+E)
• Log terminal jump (Cmd+L)

State and Files

Where Trellis stores runtime state — crash reports, trace reports, tmux sessions, temporary files — and how to clean up or fully reset it.

API

REST and WebSocket API documentation for programmatic access to Trellis.