Skip to main content

Gauntlet CLI

Gauntlet has a simple command line interface

Commands

gauntlet

Without any arguments calling Gauntlet binary will start the Gauntlet application. If application is already opened, the window of already opened application will be shown

gauntlet --minimized

By default, starting the application will open the main window. --minimized flag will start the application without opening the window. Useful when starting the application automatically on OS startup

gauntlet open

Opens main application window, if application is already running. Can be used instead of global shortcut

gauntlet settings

Opens Gauntlet settings

gauntlet run <plugin-id> <entrypoint-id> <action-id>

Runs commands, opens views, runs specific actions, can be used as a replacement for entrypoint-specific global shortcuts, e.g. if global shortcuts are not supported on your system

  • <plugin-id>
    • Plugin ID, same value as the one used during installation
    • Also shown in Settings UI
  • <entrypoint-id>
  • <action-id>

gauntlet --version

Shows Gauntlet version