Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

osga24/Quick-Jump

Repository files navigation

πŸš€ QuickJump

QuickJump is a beautiful, practical command-line tool that allows you to quickly jump to frequently used directories using custom hotkeys. Say goodbye to lengthy cd commands and boost your productivity!

QuickJump Demo

✨ Features

  • πŸ“ Instantly jump to any directory with simple hotkeys
  • 🏷️ Create custom hotkeys for your most frequently visited directories
  • 🎨 Beautiful colorful interface with emoji decorations
  • πŸ”„ Command and hotkey auto-completion
  • πŸ’Ύ Configuration files in JSON format for easy management and backup
  • 🧹 Simple installation and uninstallation process
  • πŸ• Good pizza has no pineapple on it!

πŸ“‹ Requirements

  • Bash or Zsh shell
  • jq tool (for JSON processing)

πŸ”§ Installation

Automatic Installation

# Download the installer
git clone https://github.com/osga24/Quick-Jump.git
# Change to installation directory
cd Quick-Jump/
# Make it executable
chmod +x install.sh
# Run the installer
./install.sh

The installation script will automatically:

  1. Check and install required dependencies
  2. Create necessary configuration directories and files
  3. Set up shell integration
  4. Configure command auto-completion

Manual Installation

If you prefer manual installation, follow these steps:

  1. Make sure jq is installed:

    # macOS
    brew install jq
    # Debian/Ubuntu
    sudo apt install jq
    # RHEL/CentOS
    sudo yum install jq
  2. Create configuration directory:

    mkdir -p ~/.config/quickjump
  3. Download script files:

    curl -o ~/.config/quickjump/quickjump.sh https://raw.githubusercontent.com/osga24/Quick-Jump/main/quickjump.sh
    curl -o ~/.config/quickjump/quickjump-function.sh https://raw.githubusercontent.com/osga24/Quick-Jump/main/quickjump-function.sh
    chmod +x ~/.config/quickjump/quickjump.sh
  4. Add to your shell configuration:

    echo '# QuickJump - Fast Directory Navigation Tool' >> ~/.zshrc # or ~/.bashrc
    echo 'source ~/.config/quickjump/quickjump-function.sh' >> ~/.zshrc # or ~/.bashrc
  5. Reload configuration:

    source ~/.zshrc # or ~/.bashrc

πŸ“– Usage

Basic Commands

# Add current directory as a hotkey
qj add work
# Add a specific directory as a hotkey
qj add docs ~/Documents
# Jump to a directory using its hotkey
qj work
# List all hotkeys
qj list
# Remove a hotkey
qj remove work
# Display help information
qj help

Tips and Tricks

  • Set intuitive hotkeys for your most frequently used directories
  • Use tab completion to quickly select existing hotkeys
  • If a directory no longer exists, QuickJump will prompt you to remove the hotkey

πŸ—‘οΈ Uninstallation

To uninstall QuickJump, simply run the provided uninstallation script:

# Get the uninstaller
git clone https://github.com/osga24/Quick-Jump.git
cd Quick-Jump/
# Make it executable
chmod +x uninstall.sh
# Run the uninstaller
./uninstall.sh

The uninstallation script provides options to backup your configuration and cleans up all related files and settings.

🀝 Contributing

Issues and Pull Requests are welcome to improve QuickJump! Whether it's fixing bugs, adding new features, or improving documentation, we appreciate all contributions.

πŸ“œ License

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

πŸ‘¨β€πŸ’» Author

For any questions or suggestions, feel free to open an issue or contact us. Happy jumping!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /