Skip to main content
Termy provides a powerful command-line interface (termy-cli) for managing configuration, listing system resources, and accessing terminal features without opening the GUI.

​
Installation

The CLI tool is installed automatically with Termy and is available as:
  • Binary name: termy-cli
  • Version: Check with termy-cli -version
The CLI tool is separate from the main Termy application and can be used independently to manage your configuration and inspect system resources.

​
Quick Start

View all available commands: 
termy-cli -help

​
Available Commands

​
Information & Discovery

CommandDescription
-helpShow all available commands
-versionDisplay version information
-list-fontsList available monospace fonts on your system
-list-themesShow all built-in color themes
-list-keybindsDisplay all keyboard shortcuts
-list-colorsShow colors for the current theme
-list-actionsList available keybind actions

​
Configuration Management

CommandDescription
-show-configDisplay current configuration
-edit-configOpen config file in your editor
-validate-configCheck configuration file for errors
-prettify-configFormat config file (removes comments)

​
Interactive Interface

CommandDescription
-tuiLaunch interactive TUI for all CLI features

​
Updates

CommandDescription
-updateCheck for available updates

​
Common Usage Patterns

​
Discovering Available Resources

Before customizing your terminal, explore what’s available: 
# See all monospace fonts on your system
termy-cli -list-fonts

​
Managing Configuration

Quickly edit and validate your configuration: 
# Opens config in $EDITOR (or platform default)
termy-cli -edit-config

​
Working with Keybindings

Inspect and discover keyboard shortcuts: 
# See all keyboard shortcuts and their actions
termy-cli -list-keybinds

​
Interactive TUI Mode

For a more visual experience, launch the interactive TUI: 
termy-cli -tui
The TUI provides:
  • Easy navigation between all CLI features
  • Visual display of configuration, themes, fonts, and keybindings
  • Live validation feedback
  • Quick access to edit config
See TUI Interface for detailed documentation.

​
Configuration File Location

The CLI operates on your Termy configuration file located at:
  • macOS: ~/.config/termy/config
  • Linux: ~/.config/termy/config
  • Windows: %APPDATA%\termy\config
If the config file doesn’t exist, Termy uses default settings. Use termy-cli -edit-config to create it.

​
Output Formats

CLI commands output plain text for easy parsing and scripting: 
# Pipe font list to grep
termy-cli -list-fonts | grep -i "mono"

# Save theme list to file
termy-cli -list-themes > themes.txt

# Count available actions
termy-cli -list-actions | wc -l

​
Exit Codes

The CLI follows standard exit code conventions:
  • 0: Success
  • 1: Error (invalid config, validation failure, etc.)
termy-cli -validate-config
if [ $? -eq 0 ]; then
  echo "Config is valid"
else
  echo "Config has errors"
fi

​
Next Steps

List Fonts

Discover available monospace fonts

List Themes

Browse built-in color themes

Config Management

Edit and validate configuration

Interactive TUI

Use the visual interface

Build docs developers (and LLMs) love

Get started for freeTalk to us