go-quickswitch

Go Version of QuickSwitch (https://github.com/HellstromIT/quickswitch)

• go-quickswitch
• About
  • WHY?
• Installation
  • Download Packages
  • First run
  • Add first search path
  • Add shell functions
    • Bash
    • Fish
    • zsh
    • powershell

About

WHY?

The reasoning behind this package is the following. I've realised that I'm constantly switching between different git repositories on a normal day. To speed up the process of switching I wanted a tool that implemented would allow me to fuzzy search a set of directories containing git repositories. And that's how the idea behind quickswitch was born!:)

Installation

Download Packages

Download the latest release from https://github.com/HellstromIT/go-quickswitch/releases, unpack it and install to your path:

Linux:

tar -xvf go-quickswitch_v0.1.0_linux_amd64.tar.gz
sudo cp go-quickswitch /usr/local/bin/

Mac: (TBD)

Windows: (TBD)

First run

On first run the configuration file will be generated with the current working directory added as a search path. The program will exit telling you to re-run to search and also indicating where the config file is located.

Add first search path

There's no default search directories out of the box so to add a directory you wish to include run:

Linux/Mac:

go-quickswitch add /path/to/search/directory [--git] [--depth 2]

Windows:

go-quickswitch.exe add /path/to/search/directory [--git] [--depth 2]

--git and --depth are optional. --git defaults to false if omitted and --depth defaults to 0 if omitted.

--git indicates that this is a folder containing multiple git repositories. A scan will be done to find all the git repositories if this flag is added.

--depth is used if the directory is not a git directory but you still want to find all directories down to a certain depth within it. Useful if you wanna be able to scan over a non-git tree but don't want all folders to be found.

The command will only search one level deep so if you have multiple levels that you wish to search you need to add them one at a time.

Add shell functions

In order for the command to work correctly you will also need to create a function in your shell. The below functions assume that you want the command to be qq.

After adding the relevant function restart your shell.

Bash

Add the following to your $HOME/.bashrc or in $HOME/.bash_functions.d/qq.sh

qq () {
  directory=$(go-quickswitch)
  if [ -z "$directory" ]
  then
    echo
  else
    cd $directory
  fi
}

Fish

Create a function in $HOME/.config/fish/functions/qq.fish

function qq
    if [ -n "$argv[1]" ]
        switch "$argv[1]"
            case add
                go-quickswitch add $argv[2..-1]
            case remove
                go-quickswitch remove $argv[2..-1]
            case version
                go-quickswitch version $argv[2..-1]
            case help
                go-quickswitch -h
        end
    else
        cd (go-quickswitch)
    end
end

function __fish_qq_needs_command
  set cmd (commandline -opc)
  if [ (count $cmd) -eq 1 -a $cmd[1] = 'qq' ]
    return 0
  end
  return 1
end

complete -f -c qq -n '__fish_qq_needs_command' -a add
complete -f -c qq -n '__fish_qq_needs_command' -a delete
complete -f -c qq -n '__fish_qq_needs_command' -a version
complete -f -c qq -n '__fish_qq_needs_command' -a help

zsh

Create a function in $HOME/.zshrc

qq () {
  directory=$(go-quickswitch)
  if [ -z "$directory" ]
  then
    echo
  else
    cd $directory
  fi
}

powershell

(TBD)

After adding the functions restart your shell and press qq to use the tool.

Happy Dir Switching!:)