Reference

Comprehensive reference documentation for Two-Face.

Quick Access

How to Use This Section

This reference section is designed for lookup, not learning. Use it when you:

• Need exact syntax for a configuration option
• Want to know all available values for a setting
• Need to look up a specific color name or stream ID
• Are troubleshooting a configuration issue

For learning and tutorials, see:

• Getting Started - Initial setup
• Tutorials - Step-by-step guides
• Configuration - Configuration concepts

Quick Reference Cards

Common CLI Flags

two-face --host HOST --port PORT    # Lich mode
two-face --direct --account X ...   # Direct mode
two-face --config PATH              # Custom config
two-face --debug                    # Debug logging

Essential Config Keys

[connection]
mode = "lich"           # or "direct"
host = "127.0.0.1"
port = 8000

[[widgets]]
type = "text"           # Widget type
name = "main"           # Unique name
x = 0                   # Position (0-100)
y = 0
width = 100             # Size (0-100)
height = 100

Common Keybind Actions

[keybinds."key"]
action = "scroll_up"        # Widget action
macro = "command"           # Send command

Stream Quick Reference

Conventions

Value Types

Color Values

Colors can be specified as:

• Preset name: "red", "bright_blue"
• Hex code: "#ff0000"
• RGB: (in some contexts)

Path Values

Paths support:

• Absolute: /home/user/.two-face/
• Home expansion: ~/.two-face/
• Relative (from config location)

See Also

• Configuration Guide
• Tutorials
• Troubleshooting