Skip to content
Raffi

Configuration Overview

Configuration File Location

Section titled “Configuration File Location”

Raffi’s configuration is stored in:

$HOME/.config/raffi/raffi.yaml

You can override this location using the -c or --configfile flag:

Terminal window
raffi --configfile /path/to/custom/config.yaml

Basic Structure

Section titled “Basic Structure”

The configuration file is a YAML file with three main sections:

  1. General settings - UI preferences, theme, fonts, window dimensions
  2. Entries - Application launcher entries
  3. Addons - Optional features like script filters, web searches, text snippets

Minimal Example

Section titled “Minimal Example”
launchers:
  firefox:
    binary: firefox
    args: [--marionette]
    icon: firefox
    description: Firefox browser with marionette enabled

Complete Structure

Section titled “Complete Structure”
version: 1


# General settings (optional)
general:
  ui_type: native
  theme: dark
  font_size: 20
  window_width: 800
  window_height: 600


# Launcher entries
launchers:
  firefox:
    binary: firefox
    description: "Firefox"
    icon: firefox
    args: ["--marionette"]


  terminal:
    binary: kitty
    description: "Terminal"
    icon: terminal


# Addons (optional)
addons:
  script_filters:
    - name: "Timezones"
      keyword: "tz"
      command: "batz"
      args: ["-j"]


  web_searches:
    - name: "Google"
      keyword: "g"
      url: "https://google.com/search?q={query}"

Configuration Sections

Section titled “Configuration Sections”

General Settings

UI type, theme, fonts, and window settings

Entries

Define launcher entries with binaries, scripts, and arguments

Icons

Icon caching, discovery, and path configuration

Scripts

Inline scripts with bash, python, or custom interpreters

Conditions

Conditional visibility based on environment or binary existence

Addons

Optional features like script filters, web searches, and text snippets

Path Expansion

Section titled “Path Expansion”

Most configuration fields support path expansion:

  • ~/ expands to your home directory
  • ${VAR} expands to environment variable values
  • Unset variables expand to empty strings
launchers:
  myapp:
    binary: ${HOME}/bin/myapp
    args: ["${XDG_DATA_HOME}/files", "~/Documents"]
    icon: ~/icons/myapp.png
    ifexist: ~/bin/myapp