Skip to content

ali-master/quick-cmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

QuickCMD Logo

QuickCMD

⚑ Lightning-fast command launcher for macOS

Execute scripts, open files, and manage workflows with beautiful menubar integration

macOS Support React Tauri TypeScript

Features Installation Usage Development


🌟 What is QuickCMD?

QuickCMD is a modern, lightning-fast command launcher designed specifically for macOS. It lives in your menubar and provides instant access to your most-used commands, scripts, and files. Think of it as a beautiful, powerful alternative to Spotlight for developers and power users.

🎯 Why QuickCMD?

  • ⚑ Instant Access: Global shortcuts and menubar integration
  • 🎨 Beautiful UI: Modern glass-morphism design with smooth animations
  • πŸ” Smart Search: Fuzzy search with command history and favorites
  • ⌨️ Keyboard-First: Navigate entirely with keyboard shortcuts
  • πŸ›‘οΈ Secure: Sandboxed execution with fine-grained permissions
  • πŸ”§ Extensible: Easy to add custom commands and workflows

✨ Features

πŸš€ Core Functionality

  • Global Shortcuts: ⌘ + Space to open from anywhere
  • Menubar Integration: Click the tray icon to toggle the launcher
  • Smart Search: Real-time filtering with fuzzy matching
  • Command History: Recently used commands for quick access
  • Favorites System: Star your most-used commands

πŸŽ›οΈ Command Types

  • Shell Commands: Execute any terminal command
  • File Operations: Open files and directories
  • Application Launchers: Quick access to your apps
  • Custom Scripts: Run your own automation scripts

🎨 User Experience

  • Glass Morphism UI: Modern, translucent design
  • Smooth Animations: Powered by Framer Motion
  • Keyboard Navigation: Arrow keys + Enter to execute
  • Auto-positioning: Window appears below menubar icon
  • Auto-hide: Hides when losing focus

πŸ”’ Security & Performance

  • Sandboxed Execution: Secure command execution
  • Native Performance: Built with Tauri for speed
  • Low Memory Footprint: Efficient resource usage
  • Background Operation: Runs quietly in the background

πŸ“‹ Table of Contents


πŸš€ Installation

πŸ“¦ Pre-built Releases (Coming Soon)

Download the latest release from the Releases page.

πŸ”¨ Build from Source

Prerequisites

Ensure you have the following installed:

Build Steps

# Clone the repository
git clone https://github.com/ali-master/quick-cmd.git
cd quick-cmd

# Install dependencies
bun install

# Development mode (with hot reload)
bun run app:dev

# Production build
bun run app:build

The built application will be in src-tauri/target/release/bundle/macos/.


πŸ“– Usage

🎬 Getting Started

  1. Launch QuickCMD: Open the built application
  2. Look for the menubar icon: Find the QuickCMD icon in your macOS menubar
  3. Open the launcher: Click the icon or press ⌘ + Space
  4. Start typing: Search for commands, files, or applications
  5. Execute: Press Enter or click to run the selected item

πŸ” Search & Execute

πŸ” Type to search...
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ > terminal                      β”‚
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ ⭐ Open Terminal                β”‚
β”‚ πŸ“ Open VS Code                 β”‚
β”‚ πŸ”§ Git Status                   β”‚
β”‚ πŸ“‚ Open Finder                  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

⭐ Managing Favorites

  • Add to Favorites: Click the star icon next to any command
  • Quick Access: Favorites appear at the top of search results
  • Remove: Click the star again to unfavorite

πŸ“Š Command History

QuickCMD automatically tracks your command usage:

  • Recent Commands: Shows your last 5 executed commands
  • Frequency Ranking: Most-used commands appear higher in results
  • Smart Suggestions: Learns your patterns over time

⌨️ Keyboard Shortcuts

Shortcut Action
⌘ + Space Toggle QuickCMD window
↑ / ↓ Navigate command list
Enter Execute selected command
Escape Hide QuickCMD window
⌘ + , Open preferences (coming soon)
⌘ + Q Quit QuickCMD

πŸŽ›οΈ Configuration

πŸ“ Default Commands

QuickCMD comes with these built-in commands:

  • Open Terminal - open -a Terminal
  • Open VS Code - code .
  • Git Status - git status
  • Open Finder - open .

βž• Adding Custom Commands

(Feature coming soon - will support JSON configuration file)

{
  "commands": [
    {
      "name": "Deploy to Production",
      "command": "npm run deploy:prod",
      "type": "script",
      "icon": "πŸš€",
      "favorite": true
    }
  ]
}

βš™οΈ Settings

  • Global Shortcut: Customize the global hotkey
  • Window Position: Choose where the window appears
  • Theme: Light/Dark/Auto modes
  • Startup: Launch on system startup

πŸ› οΈ Development

πŸ—οΈ Tech Stack

  • Frontend: React 19 + TypeScript + Vite
  • Backend: Rust + Tauri 2.0
  • UI: Tailwind CSS v4 + shadcn/ui
  • Icons: Lucide React
  • Animations: Framer Motion
  • Build: Bun

πŸ“ Project Structure

quick-cmd/
β”œβ”€β”€ src/                    # React frontend
β”‚   β”œβ”€β”€ components/         # UI components
β”‚   β”‚   β”œβ”€β”€ ui/            # shadcn/ui components
β”‚   β”‚   └── command-launcher.tsx
β”‚   β”œβ”€β”€ libs/              # Utilities
β”‚   └── assets/            # Static assets
β”œβ”€β”€ src-tauri/             # Rust backend
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ lib.rs         # Main Tauri logic
β”‚   β”‚   └── main.rs        # Entry point
β”‚   β”œβ”€β”€ Cargo.toml         # Rust dependencies
β”‚   └── tauri.conf.json    # Tauri configuration
β”œβ”€β”€ assets/                # Logos and graphics
β”œβ”€β”€ docs/                  # Documentation
└── package.json           # Node.js dependencies

πŸ”§ Development Commands

# Start development server
bun run app:dev

# Type checking
bun run test:types

# Linting
bun run lint

# Format code
bun run format

# Build for production
bun run app:build

πŸ§ͺ Testing

# Run Rust tests
cd src-tauri && cargo test

# Type checking
bun run test:types

πŸ“š Documentation

Detailed documentation is available in the docs/ folder:


πŸš€ Roadmap

🎯 Near Term (v0.1.0)

  • Menubar integration
  • Command execution
  • Search functionality
  • Favorites system
  • Settings panel
  • Custom command configuration

🌟 Medium Term (v0.2.0)

  • Plugin system
  • Workflow automation
  • Advanced search filters
  • Command aliases
  • Export/import settings

πŸš€ Long Term (v1.0.0)

  • Multi-platform support
  • Team sharing features
  • Advanced integrations
  • Performance analytics

🀝 Contributing

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

πŸ› Bug Reports

Found a bug? Open an issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • macOS version and QuickCMD version

πŸ’‘ Feature Requests

Have an idea? Start a discussion to:

  • Describe the feature
  • Explain the use case
  • Discuss implementation approaches

πŸ”§ Pull Requests

Ready to contribute code?

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes and test thoroughly
  4. Follow our coding standards (ESLint + Prettier)
  5. Submit a pull request with a clear description

πŸ“‹ Development Guidelines

  • Code Style: We use ESLint + Prettier with strict TypeScript
  • Commits: Use conventional commit messages
  • Testing: Add tests for new features
  • Documentation: Update docs for user-facing changes

πŸ“Š Stats

GitHub stars GitHub forks GitHub issues GitHub license


πŸ“„ License

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


πŸ™ Acknowledgments


Made with ❀️ by Ali Torki

πŸ› Report Bug Β· πŸ’‘ Request Feature Β· πŸ’¬ Discussions


⭐ Star this repo if you find it useful!

About

Lightning-fast command launcher for macOS

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published