SwitchShuttle

🚀 Cross-platform terminal command manager with global hotkeys

🇺🇸 English • 🇨🇳 中文 • 🇷🇺 Русский • 🇩🇪 Deutsch • 🇯🇵 日本語

---

✨ What is SwitchShuttle?

SwitchShuttle is a powerful cross-platform system tray application that revolutionizes how you manage and execute terminal commands. Built with modern technologies (Rust + Tauri + Vue.js), it provides a sleek interface for organizing, customizing, and quickly accessing your most-used terminal operations.

🎯 Key Features

• 🖥️ Multi-Platform Support - Works seamlessly on macOS, Windows, and Linux
• ⚡ Global Hotkeys - Execute commands instantly from anywhere with keyboard shortcuts
• 🎨 Multiple Terminal Support - iTerm, Terminal, Warp, Alacritty, Hyper, and more
• 📁 Smart Organization - Create nested submenus for better command organization
• 🔧 Dynamic Inputs - Interactive prompts for commands that need user input
• 🔄 Multiple Execution Modes - Run in current window, new tab, or new window
• 🚀 Auto-Start - Launch at system startup for instant access
• 🎨 Modern UI - Beautiful, intuitive interface built with Vue.js

🚀 Quick Start

Download & Install

Option 1: Homebrew (macOS - Recommended)

# Install via Homebrew
brew tap s00d/switchshuttle
brew install --cask switchshuttle

Option 2: Manual Download

1. Download the latest release for your platform from GitHub Releases
2. Install the application
3. Launch SwitchShuttle - it will appear in your system tray
4. Right-click the tray icon to access the menu

First Configuration

1. Edit Config → Opens your configuration file in your default editor
2. Add your commands using the JSON format (see examples below)
3. Save and restart the application
4. Enjoy your organized command shortcuts!

📋 Configuration Guide

Basic Structure

SwitchShuttle uses JSON configuration files stored in:

• macOS/Linux: ~/.config/switch-shuttle/
• Windows: C:\Users\<Username>\AppData\Roaming\switch-shuttle\

Simple Example

{
  "terminal": "iterm",
  "launch_in": "new_tab",
  "title": "My Commands",
  "commands": [
    {
      "name": "🚀 Start Development Server",
      "command": "npm run dev",
      "hotkey": "Ctrl+Shift+D"
    },
    {
      "name": "📦 Install Dependencies",
      "command": "npm install",
      "hotkey": "Ctrl+Shift+I"
    },
    {
      "name": "🔧 Development Tools",
      "submenu": [
        {
          "name": "🧪 Run Tests",
          "command": "npm test",
          "hotkey": "Ctrl+Shift+T"
        },
        {
          "name": "📊 Build Project",
          "command": "npm run build",
          "hotkey": "Ctrl+Shift+B"
        }
      ]
    }
  ]
}

Advanced Features

🔧 Dynamic Inputs

Create interactive commands that prompt for user input:

{
  "name": "📝 Create New Component",
  "inputs": {
    "componentName": "MyComponent",
    "componentType": "functional"
  },
  "commands": [
    "mkdir -p src/components/[componentName]",
    "touch src/components/[componentName]/index.tsx",
    "echo 'import React from \"react\";' > src/components/[componentName]/index.tsx",
    "echo 'export const [componentName] = () => <div>[componentName]</div>;' >> src/components/[componentName]/index.tsx"
  ],
  "hotkey": "Ctrl+Shift+N"
}

🔄 Multiple Commands

Execute a sequence of commands:

{
  "name": "🔄 Full Development Cycle",
  "commands": [
    "git pull origin main",
    "npm install",
    "npm run lint",
    "npm run test",
    "npm run build"
  ],
  "hotkey": "Ctrl+Shift+F"
}

📁 Nested Submenus

Organize commands in hierarchical menus:

{
  "name": "🐳 Docker Operations",
  "submenu": [
    {
      "name": "🚀 Start Services",
      "submenu": [
        {
          "name": "🏗️ Development",
          "command": "docker-compose -f docker-compose.dev.yml up -d"
        },
        {
          "name": "🏭 Production",
          "command": "docker-compose -f docker-compose.prod.yml up -d"
        }
      ]
    },
    {
      "name": "🛑 Stop All",
      "command": "docker-compose down"
    }
  ]
}

⚙️ Configuration Reference

Main Configuration

Parameter	Type	Description	Default
terminal	String	Terminal application to use	"terminal"
launch_in	String	Where to launch commands	"current"
theme	String	Terminal theme (if supported)	-
title	String	Window/tab title	-
menu_hotkey	String	Global hotkey to open menu	-
commands	Array	List of command configurations	[]

Terminal Options

Terminal	macOS	Windows	Linux
iterm	✅	❌	❌
terminal	✅	✅	✅
warp	✅	❌	❌
alacritty	✅	✅	✅
hyper	✅	✅	✅

Launch Modes

Mode	Description
current	Execute in current terminal window
new_tab	Open new tab and execute
new_window	Open new window and execute

Command Configuration

Parameter	Type	Required	Description
name	String	✅	Display name for the command
command	String	❌	Single command to execute
commands	Array	❌	Multiple commands to execute
submenu	Array	❌	Nested subcommands
inputs	Object	❌	Dynamic input fields
hotkey	String	❌	Global hotkey shortcut

🎯 Use Cases

👨‍💻 Developers

• Quick project navigation - Jump to different projects instantly
• Build and test workflows - One-click development cycles
• Docker management - Start/stop containers with hotkeys
• Git operations - Common git commands at your fingertips

🛠️ DevOps Engineers

• Server management - SSH connections and server commands
• Monitoring tools - Quick access to logs and metrics
• Deployment scripts - Automated deployment workflows
• Database operations - Common database commands

🎨 Designers

• Asset optimization - Image processing and optimization
• Design system tools - Component generation and updates
• Prototype servers - Quick design server startup

🔧 Building from Source

Prerequisites

• Rust (latest stable)
• Node.js (v16 or higher)
• Tauri CLI

Build Steps

# Clone the repository
git clone https://github.com/s00d/switchshuttle.git
cd switchshuttle

# Install dependencies
npm install

# Development mode
npm run tauri dev

# Build for production
npm run tauri build

Platform-Specific Notes

macOS

# If you encounter signing issues
chmod +x /Applications/switch-shuttle.app
xattr -cr /Applications/switch-shuttle.app
codesign --force --deep --sign - /Applications/switch-shuttle.app

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Guidelines

• Follow the existing code style
• Add tests for new features
• Update documentation as needed
• Ensure cross-platform compatibility

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Inspired by the original Shuttle project
• Built with Tauri for cross-platform desktop apps
• UI powered by Vue.js

📞 Support

• Issues: GitHub Issues
• Releases: GitHub Releases

---

Made with ❤️ by the SwitchShuttle community

⭐ Star this repository if you find it useful!