Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration

Config file location

siggy loads its config from a TOML file at the platform-specific path:

PlatformPath
Linux / macOS~/.config/siggy/config.toml
Windows%APPDATA%\siggy\config.toml

You can override the path with the -c flag:

siggy -c /path/to/config.toml

Config fields

All fields are optional. Here is a complete example with defaults:

account = "+15551234567"
signal_cli_path = "signal-cli"
download_dir = "/home/user/signal-downloads"
notify_direct = true
notify_group = true
desktop_notifications = false
inline_images = true
native_images = false
show_receipts = true
color_receipts = true
nerd_fonts = false
reaction_verbose = false
send_read_receipts = true
mouse_enabled = true
theme = "Default"
keybinding_profile = "Default"
proxy = ""

Field reference

FieldTypeDefaultDescription
accountstring""Phone number in E.164 format
signal_cli_pathstring"signal-cli"Path to the signal-cli binary
download_dirstring~/signal-downloads/Directory for downloaded attachments
notify_directbooltrueTerminal bell on new direct messages
notify_groupbooltrueTerminal bell on new group messages
desktop_notificationsboolfalseOS-level desktop notifications for incoming messages
inline_imagesbooltrueRender image attachments as halfblock art
native_imagesboolfalseUse native terminal image protocols (Kitty/iTerm2)
show_receiptsbooltrueShow delivery/read receipt status symbols
color_receiptsbooltrueColored receipt status symbols (vs monochrome)
nerd_fontsboolfalseUse Nerd Font glyphs for status symbols
reaction_verboseboolfalseShow reaction sender names instead of counts
send_read_receiptsbooltrueSend read receipts when viewing conversations
mouse_enabledbooltrueEnable mouse support (click sidebar, scroll, etc.)
themestring"Default"Color theme name
keybinding_profilestring"Default"Keybinding profile (Default, Emacs, Minimal, or custom)
proxystring""Signal TLS proxy URL passed through to signal-cli

CLI flags

CLI flags override config file values for the current session:

FlagOverrides
-a +15551234567account
-c /path/to/config.tomlConfig file path
--incognitoUses in-memory database (no persistence)

Settings overlay

Settings overlay

Press /settings inside the app to open the settings overlay. This provides toggles for runtime settings:

  • Notification toggles (direct / group / desktop)
  • Sidebar visibility
  • Inline image previews / native images
  • Show read receipts / receipt colors / nerd font icons
  • Verbose reactions
  • Send read receipts
  • Mouse support
  • Theme selector
  • Keybinding profile selector

Changes made in the settings overlay are saved to the config file when you close the overlay, and persist across sessions.

Incognito mode

siggy --incognito

Incognito mode replaces the on-disk SQLite database with an in-memory database. No messages, conversations, or read markers are saved. When you exit, all data is gone. The status bar shows a bold magenta incognito indicator.