Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/s00d/switchshuttle

SwitchShuttle is a cross-platform system tray application that allows users to run predefined commands in various terminal applications. It supports macOS, Windows, and Linux, offering a simple and customizable way to manage and execute your frequently used commands.
https://github.com/s00d/switchshuttle

Last synced: 3 months ago
JSON representation

SwitchShuttle is a cross-platform system tray application that allows users to run predefined commands in various terminal applications. It supports macOS, Windows, and Linux, offering a simple and customizable way to manage and execute your frequently used commands.

Awesome Lists containing this project

README 

        
![SwitchShuttle](https://raw.githubusercontent.com/s00d/switchshuttle/main/icons/logo.webp)

![intro](https://github.com/s00d/switchshuttle/blob/main/icons/intro.gif?raw=true)





  English | 

  中文 | 

  Русский | 

  Deutsch | 

  日本語




## SwitchShuttle



SwitchShuttle is a cross-platform system tray application that allows users to run predefined commands in various terminal applications. It supports macOS, Windows, and Linux, offering a simple and customizable way to manage and execute your frequently used commands.



## About



SwitchShuttle is a reimagining and extension of the [Shuttle](https://github.com/fitztrev/shuttle) application. While Shuttle provides a simple and effective way to manage commands shortcuts in macOS, SwitchShuttle expands upon this concept, offering support for multiple operating systems and terminal emulators, along with enhanced configuration capabilities and user customization options.



## Features



- Supports multiple terminal applications: iTerm, Terminal, Warp, Alacritty, Hyper.

- Run commands in different modes: current window, new tab, new window.

- Toggle launch at login.

- Edit configuration directly from the tray menu.

- Open configuration folder from the tray menu.

- Supports submenus for better organization of commands.

- Supports dynamic inputs for commands.

- **New**: Trigger context menu with a hotkey.



## Configuration



The configuration is stored in JSON files located in the user's configuration directory. The default path is `~/.config/switch-shuttle/` on Linux and macOS, and `C:\Users\\AppData\Roaming\switch-shuttle\` on Windows. You can store multiple configuration files in this directory, each representing a different set of commands and settings.



Here is an example of a configuration file:



```json

{

  "terminal": "iterm",

  "launch_in": "current",

  "theme": "Homebrew",

  "title": "New tab",

  "menu_hotkey": "Ctrl+Shift+M",

  "commands": [

    {

      "name": "Command",

      "inputs": null,

      "command": null,

      "commands": null,

      "hotkey": null,

      "submenu": [

        {

          "name": "Example Command",

          "inputs": null,

          "command": "echo Hello, world!",

          "commands": null,

          "submenu": null,

          "hotkey": "Ctrl+Shift+E"

        },

        {

          "name": "Example Multi-Command with input",

          "inputs": {

            "key1": "default1",

            "key2": "default2"

          },

          "command": null,

          "commands": [

            "export MY_VAR=$(echo 'Step 1: [key1]')",

            "RESULT=$(echo 'Step 2: [key2]' && echo $MY_VAR)",

            "echo Step 3: Finalize && echo $RESULT"

          ],

          "submenu": null,

          "hotkey": "Ctrl+Shift+M"

        },

        {

          "name": "Example Submenu",

          "inputs": null,

          "command": null,

          "commands": null,

          "submenu": [

            {

              "name": "Subcommand 1",

              "inputs": null,

              "command": "echo Subcommand 1",

              "commands": null,

              "submenu": null,

              "hotkey": "Ctrl+Shift+S"

            },

            {

              "name": "Subcommand 2",

              "inputs": null,

              "command": "echo Subcommand 2",

              "commands": null,

              "submenu": null,

              "hotkey": null

            }

          ],

          "hotkey": null

        }

      ]

    }

  ]

}

```



### Configuration Parameters



| Parameter   | Type              | Description                                     | Valid Values                                       |

|-------------|-------------------|-------------------------------------------------|----------------------------------------------------|

| terminal    | String            | The terminal application to use                 | "iterm", "terminal", "warp"                        |

| launch_in   | String            | Where to launch the command                     | "current", "new_tab", "new_window"                 |

| theme       | String            | The theme to use (if supported by the terminal) | Any string value representing a theme              |

| title       | String            | The title to set for the terminal window/tab    | Any string value                                   |

| menu_hotkey | String (Optional) | The global hotkey to trigger the context menu   | Any valid hotkey combination, e.g., "Ctrl+Shift+M" |

| commands    | Array             | List of command configurations                  | See below for command parameters                   |



### Command Parameters



| Parameter | Type              | Description                                    | Valid Values                                       |

|-----------|-------------------|------------------------------------------------|----------------------------------------------------|

| name      | String            | The name of the command or submenu             | Any string value                                   |

| inputs    | Object (Optional) | Key-value pairs for inputs                     | {"key1": "default1", "key2": "default2"}           |

| command   | String (Optional) | The command to execute (if this is a command)  | Any string value representing a command            |

| commands  | Array (Optional)  | List of commands to execute sequentially       | Any array of strings, each string a command        |

| submenu   | Array (Optional)  | List of subcommands (if this is a submenu)     | See above for command parameters                   |

| hotkey    | String (Optional) | The global hotkey to trigger the command       | Any valid hotkey combination, e.g., "Ctrl+Shift+E" |



### Command Execution Logic



SwitchShuttle supports defining a single command using the `command` parameter, a list of commands using the `commands` parameter, or both. If both `command` and `commands` are specified, the single command will be executed first, followed by the commands in the list.



#### Example Execution Flow



1. **Single Command**: If only `command` is specified, that command is executed.

2. **Multiple Commands**: If only `commands` is specified, each command in the list is executed sequentially.

3. **Both Command and Commands**: If both `command` and `commands` are specified, the single command is executed first, followed by each command in the `commands` list.



### Dynamic Inputs



SwitchShuttle allows you to define dynamic inputs for commands. These inputs will be requested from the user before the command is executed. You can define inputs using the `inputs` parameter in the command configuration.



#### Example Configuration with Inputs



```json

{

  "name": "Example Multi-Command with input",

  "inputs": {

    "key1": "default1",

    "key2": "default2"

  },

  "command": null,

  "commands": [

    "export MY_VAR=$(echo 'Step 1: [key1]')",

    "RESULT=$(echo 'Step 2: [key2]' && echo $MY_VAR)",

    "echo Step 3: Finalize && echo $RESULT"

  ],

  "submenu": null,

  "hotkey": "Ctrl+Shift+M"

}

```



### Hotkeys



You can assign global hotkeys to commands by adding the `hotkey` parameter to the command configuration. The hotkey combination must follow the format of modifier keys (Ctrl, Shift, Alt, Win) combined with a key (A-Z, 0-9, etc.). For example, to set "Ctrl+Shift+E" as a hotkey for a command:



```json

{

  "name": "Example Command",

  "command": "echo Hello, world!",

  "submenu": null,

  "hotkey": "Ctrl+Shift+E",

  "commands": null

}

```



The hotkey parameter is optional. If it is not specified, the command will not have a global hotkey associated with it.



### How to Use Hotkeys



1. **Assign Hotkeys**: Edit the configuration file to include the `hotkey` parameter for the commands you want to trigger with global hotkeys.

2. **Use Hotkeys**: After restarting the application, use the assigned hotkeys to trigger the corresponding commands, no matter which application is currently in focus.



## How to Use



1. **Edit Config**: Right-click the tray icon and select config to open the configuration file in your default editor. Modify the configuration as needed.

2. **Show Config Folder**: Right-click the tray icon and select "Show Config Folder" to open the configuration directory in your file explorer.

3. **Toggle Launch at Login**: Right-click the tray icon and select "Toggle Launch at Login" to enable or disable the application to start at login.

4. **Execute Command**: Left-click the tray icon and select the command you want to run from the menu. The command will be executed in the specified terminal application.



### Creating Submenus



To create submenus, set the `command` and `commands` field to `null` and provide a list of subcommands in the `submenu` field. Subcommands can also have their own submenus, allowing for nested menus.



## Building the Application



### Prerequisites



- [Rust](https://www.rust-lang.org/tools/install)

- [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites/)



### Steps



1. Clone the repository:

```sh

git clone https://github.com/s00d/switchshuttle.git

cd switchshuttle

npm i

```



2. Build the application:

```sh

cargo tauri build

```



3. Run the application:

```sh

cargo tauri dev

```



## Download



The latest version of SwitchShuttle can be downloaded from the [GitHub Releases](https://github.com/s00d/switchshuttle/releases) page.



### mac



OS Sign



If you are on macOS, you may need to sign the application before running it. Here are the steps:



1. Make the binary executable:



```bash

chmod +x /Applications/switch-shuttle.app

```



2. Clear extended attributes



and sign the binary:



```bash

xattr -cr /Applications/switch-shuttle.app && codesign --force --deep --sign - /Applications/switch-shuttle.app

```



## Contributing



Contributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.



## License



This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.



---



Enjoy using SwitchShuttle for managing your terminal commands easily!