config.yml

## Default configuration for gravel
##
## Indentation is important! Check https://yaml.org/ if you're unfamiliar.
##
## Put this configuration in ~/.config/gravel/config.yml.
## Ommitted keys are set to sensible defaults, so you only
## need to keep what you want to change.
##
## Additionally, you can add ~/.config/gravel/platform/linux.yml (or windows)
## to overwrite your normal config with platform-specific changes. Again, you
## only need to specify what you want to change relative to your main config.
##
## Finally, you can add ~/.config/gravel/host/yourhostname.yml
## for host-specific changes. This works like the others, but trumps them.

## Configures the key for single-instance functionality.
## Set to null to disable.
single_instance: gravel

## Governs if external plugin libraries are loaded.
## Libraries are discovered in ~/.local/share/gravel/plugins/*.{so,dll}
## as well as in $XDG_DATA_DIRS with the same structure.
##
## Valid values are `disabled`, `all` and `whitelist` (see below)
external_plugins: disabled

## Filters libraries by their filename, sans extension. Absolute paths *do not*
## work, the library must still be placed in one of the supported folders.
# external_plugins:
#   whitelist:
#     - libgravel_provider_calculator
#     - my_fancy_plugin

## Binds global hotkeys to actions.
## The hotkey is configured as an emacs-like binding, though note that some
## features, such as chords, are not supported.
##
## Binding examples:
##   `A-<Space>` => Alt + Space
##   `C-M-s` => Control + Super/Windows + S
##   `a` => A
##
## A complete list of supported modifiers and keys can be found here:
## https://github.com/thorio/gravel/blob/master/gravel-core/src/hotkeys/structs.rs
hotkeys:

  ## Shows or hides the frontend. These actions are also available seperately,
  ## as `show` and `hide`
  - binding: A-<Space>
    action: show_hide

  ## Shows the frontend and pre-populates with the given query.
  # - binding: M-r
  #   action:
  #     show_with: example

## Frontend, or UI, to use. This is responsible for the elements you
## interact with.
frontend:

  ## The default FLTK-based frontend.
  plugin: fltk

  ## https://github.com/thorio/gravel/tree/master/gravel-frontend-fltk
  # config:
  #   ## Layout and sizing configuration.
  #   layout:
  #
  #     ## Scales all sizes by this factor. Useful for high DPI monitors.
  #     scale: 1.0
  #
  #     ## Then maximum number of hits shown on screen. Any less and the window
  #     ## will shrink, any more and you will be able to scroll down the list.
  #     max_hits: 6
  #
  #     ## Total window width. All other widths are calculated relative to this.
  #     window_width: 800
  #
  #     ## Whether to draw a thin, black border around the window.
  #     window_border: false
  #
  #     ## Whether to draw window decorations (title bar, close button, etc.).
  #     window_decorations: false
  #
  #     ## These are some more specific values you usually don't need to change.
  #     hit_title_height: 30
  #     hit_title_font_size: 20
  #     hit_subtitle_height: 20
  #     hit_subtitle_font_size: 12
  #     query_font_size: 25
  #     scrollbar_width: 10
  #     scrollbar_padding: 3
  #     padding: 8
  #
  #   ## Color configuration. Use the hex color: `0xRRGGBB`.
  #   ## Google has a color picker if you search for, well, "color picker".
  #   colors:
  #     background: 0x202020
  #     query_text: 0xffffff
  #     query_cursor: 0xbf6c0d
  #     query_highlight: 0xbf6c0d
  #     query_background: 0x202020
  #     hit_title: 0xffffff
  #     hit_subtitle: 0xffffff
  #     hit_highlight: 0xbf6c0d
  #     scrollbar: 0xbf6c0d
  #
  #   behaviour:
  #
  #     ## Whether or not to show the window when starting gravel
  #     start_hidden: false
  #
  #     ## Automatically hides the window when it loses focus.
  #     auto_hide: false
  #
  #     ## Exits the application instead of hiding the window.
  #     ## Requires external solution to start gravel when desired.
  #     exit_on_hide: false
  #
  #     ## Time in milliseconds after hiding in which show requests
  #     ## should be ignored. This is a workaround for weird behaviour
  #     ## in X11 where hotkeys steal focus.
  #     window_hide_debounce: 200
  #
  #     ## Automatically centers the window on the screen each time it is shown.
  #     auto_center_window: true
  #
  #     ## Shows the internal score assigned to each hit,
  #     ## useful for debugging purposes.
  #     show_scores: false

## Providers to use. These are responsible for the results you get.
## Providers each yield different sets of results, so if you need more or
## less functionality, you can configure this here.
## Each provider is referenced by the name of their plugin, and can be added
## to your configuration multiple times.
providers:

  ## Default calculator. If it detects a mathematical expression, such as
  ## `1 + 2` or `5 * sin(3)`, it will display its result at the very top of
  ## the list and allow you to copy the value to your clipboard.
  ##
  ## A complete list of supported expressions and constants can be found here:
  ## https://docs.rs/mexprp/latest/mexprp/struct.Context.html#builtin
  - plugin: calculator

    ## https://github.com/thorio/gravel/tree/master/gravel-provider-calculator
    # config:
    #   ## Changes the subtitle of the hit. Visual difference only.
    #   subtitle: Copy to Clipboard

  ## Default application finder. It will search the applications installed on
  ## your system and allow you to launch them.
  ##
  ## On Linux this will search your desktop entries,
  ## on Windows it will search the Start menu.
  - plugin: program

    ## https://github.com/thorio/gravel/tree/master/gravel-provider-program
    # config:
    #   ## On linux, paths can be configured by changing the
    #   ## XDG_DATA_DIRS environment variable.
    #
    #   ## Where to look for symlinks on Windows.
    #   ## Paths should be specified as globs.
    #   windows:
    #     shortcut_paths:
    #       - "$ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\**\\*.lnk"
    #       - "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\**\\*.lnk"

  ## Default web searcher. It will always insert a result at the very bottom of
  ## the list that, when selected, will search the web for your query.
  - plugin: websearch

    ## https://github.com/thorio/gravel/tree/master/gravel-provider-websearch
    # config:
    #   ## Determines which URL is opened. The default is Google Search.
    #   ## The placeholder `{}` is replaced with the URL-encoded query.
    #   ##
    #   ## For example, you could use:
    #   ## - `https://duckduckgo.com/?q={}`
    #   ## - `https://www.ecosia.org/search?q={}`
    #   ## - `https://www.bing.com/search?q={}`
    #   ## - `https://search.yahoo.com/search?p={}`
    #   ##
    #   url_pattern: "https://www.google.com/search?q={}"
    #
    #   ## Changes the subtitle of the hit. Visual difference only.
    #   subtitle: Web Search

  ## This is a second instance of the previous web search provider.
  ## It's set up to open the query in Google Translate and is
  ## only used when you prefix your query with "tr".
  - plugin: websearch
    keyword: tr
    config:
      url_pattern: "https://translate.google.com/?text={}"
      subtitle: Translate

  ## System provider.
  ## Provides system commands such as shutdown, log out or exiting gravel.
  - plugin: system

    ## https://github.com/thorio/gravel/tree/master/gravel-provider-system
    # config:
    #   ## Below are configurable titles and subtitles for each command.
    #   ## Linux systems can additionally configure a bash commmand to be run.
    #   ## On Windows systems, the native API is used instead.
    #
    #   exit:
    #     title: exit
    #     subtitle: Exit gravel
    #
    #   reload:
    #     title: reload
    #     subtitle: Reload gravel
    #
    #   clear_caches:
    #     title: clear caches
    #     subtitle: Clear frontend and provider caches
    #
    #   lock:
    #     title: lock
    #     subtitle: Lock the System
    #
    #     ## Specifies the to bash command to run on linux systems.
    #     command_linux: loginctl lock-session
    #
    #   logout:
    #     title: log out
    #     subtitle: Close the current session
    #     command_linux: loginctl terminate-session $(loginctl session-status | awk 'NR==1{print $1}')
    #
    #   restart:
    #     title: restart
    #     subtitle: Restart the System
    #     command_linux: shutdown -r now
    #
    #   shutdown:
    #     title: shutdown
    #     subtitle: Shut the System down
    #     command_linux: shutdown now
    #
    #   sleep:
    #     title: sleep
    #     subtitle: Put the System to sleep
    #     command_linux: systemctl suspend

  ## Process killer.
  ## Lists running processes on your system and allows you to kill them.
  ## There is currently no further configuration for this plugin.
  - plugin: kill

    ## This option disables the provider for any query that is not prefixed
    ## with this keyword, then shows only this providers results for any
    ## query that is. You can use it with any provider.
    keyword: kill

  ## Command runner.
  ## Runs the given command with either sh on Linux,
  ## or ShellExecute on Windows.
  - plugin: exec
    keyword: ">"

    ## https://github.com/thorio/gravel/tree/master/gravel-provider-exec
    # config:
    #   ## Changes the subtitle of the hit. Visual difference only.
    #   subtitle: Run Command

  ## Tool for creating your own hits.
  # - plugin: custom
  #   config:
  #     ## The configuration of this provider is a bit more in-depth,
  #     ## so please refer to the documentation:
  #     ## https://thorio.github.io/gravel/docs/gravel_provider_custom
  #     hits:
  #       - title: say hello
  #         action: "echo hello from bash"