Tl;dr: a tool to quickly work with your filesystem via saved shortcuts and historical movements. Allows user to both jump to other locations or open files in other locations in an editor of your choice with a single command.
I have a bash/zsh/nushell function named short that lets users jump to predefined directories easily.
The basic zsh function that I originally used was defined as:
bash
short() {
if [[ "$1" == "add" ]]; then
if [ ! -f ~/.config/.shorts/${2} ]; then
echo "[cmd] \`short ${2}\` -> ${PWD}"
ln -sf ./ ~/.config/.shorts/${2}
fi
else
cd ~/.config/.shorts/${1}
fi
}
However, as this required maintaining separate scripts for the various shells I use (nushell for personal, bash and zsh for work), I've found it very annoying to have to update the same script multiple times every time I want to add a new feature.
bunnyhop is supposed to replicate the behavior of short, but in a single language so it's easily updated between various shells.
This iteration also includes many improvements over the very simple shell function used before (and doesn't clutter you're system with unnecessary symlinks).
Simply clone this repo and run make from the root repo directory.
Current install script that works on the most systems with the most shells requires a system install cargo (obvi, since it's a tool written in Rust).
If you currently don't have rust or cargo set up on your system, just run the following command before installing bunnyhop
bash
curl https://sh.rustup.rs -sSf | sh
Once cargo is installed, simply run the following to install bunnyhop:
bash
git clone https://github.com/gnoat/hop.github
cd hop
cargo build --release
The default runner alias set is hp, use this to call bunnyhop from the command line (unless you set a custom alias).
If you'd like to use a different alias to call bunnyhop from your terminal, simple set the environment variable "BUNNYHOPSHELLALIAS" prior to running the make command.
If you'd like to change to a different alias after installion, again you can just set the environment variable "BUNNYHOPSHELLALIAS" and rerun the appropriate make command.
Once everything is installed and the shell hooks added, you can open the config file to set your editor and other preferences by simply typing:
console
foo@bar:~$ hp configure
The current build supports four different shells: nushell, zsh, powershell, and bash/dash/anything else that use ~/.bashrc.
To see where all your configuration resources were provisioned, use:
console
foo@bar:~$ hp locate
Config Directory -> C:\Users\you\.config\bunnyhop
Database Directory -> C:\Users\you\.config\bunnyhop\db
Bunnyhop Executable -> C:\Users\you\Projects\hop\target\release\bunnyhop.exe
For general usage help: ```console foo@bar:~$ hp help # show basic commands
hp arg1 arg2 1) First argument is required. 2) Second argument is optional.
Valid first argument commands are: be used to refer to the shortcut for future use. If no second argument is given, the high level name will be used. 2) ls or list: command to list the current shortcuts and their names. 3) v or version: both commands to show current hop version info. 4) brb: command to create a temporary shortcut to the current directory that can be jumped back to using the hp back command. 5) rm or remove: command to remove the shortcut specified by arg2 or remove shortcut to current directory if no second argument specified. 6) edit: open a file or directory within your editor of choice. 7) configure or config: open your bunnyhop configuration file. 8) locate: show all relevant installation directories if no second argument is given. If second argument is given, list the full path to the given argument. 9) ...: Any other first arguments given will be checked to see if it represents a valid directory/file to hop to. This input can be a named shortcut, a file/directory in the current directory, or a file/directory from previous hp commands.
foo@bar:~$ version # show version
bunnyhop 🐇 v.0.2.4
To add a shortcut to your directory with the shortcut name `example`:
console
foo@bar:~$ hp add example
[info] Added shortcut: example -> /home/you/parentdir/example
To add a shortcut to your current directory and use the current directory high level name as the shortcut name:
console
echo $PWD
/usr/bin/cargo
foo@bar:~$ hp add
[info] Added shortcut: cargo -> /usr/bin/cargo
To add a shortcut to a file that can be opened up in the set editor, use:
console
foo@bar:~$ hp add init.vim # will create a shortcut to init.vim named init.vim
[info] Added shortcut: init.vim -> /home/you/.config/nvim/init.vim
foo@bar:~$ hp add init.vim vi # will create a shortcut to init.vim named vi
[info] Added shortcut: vi -> /home/you/.config/nvim/init.vim
To open a shortcut file in your configured editor of choice, use either of the following:
console
foo@bar:~$ hp edit init.vim # full command consistent with opening a directory for editing
foo@bar:~$ hp init.vim # shortened command that just works for editing files and not directories
To delete a shortcut with name `example`:
console
foo@bar:~$ hp rm example # can be used from any location
[info] Removed shortcut: example.
echo $PWD C:\Users\you\Documents\example
foo@bar:~$ hp rm # can be used within the "example" directory [info] Removed shortcut: example.
foo@bar:~$ hp remove example # long form of rm command
[info] Removed shortcut: example.
To jump to the `example` named directory:
console
foo@bar:~$ hp example
To jump to the `example` named directory and open your default editor in that directory:
console
foo@bar:~$ hp edit example
To list all saved shortcuts:
console
foo@bar:~$ hp ls # shortened form
appdata -> C:\Users\you\AppData\Local
back -> C:\Users\you\Projectshop
hop -> C:\Users\you\Projectshop
hpconf -> C:\Users\you.configbunnyhop
foo@bar:~$ hp list # long form
appdata -> C:\Users\you\AppData\Local
back -> C:\Users\you\Projectshop
hop -> C:\Users\you\Projectshop
hpconf -> C:\Users\you.configbunnyhop
To capture just the full path of a shortcut, you can again use the `locate` command:
console
foo@bar:~$ hp locate init.vim # show full path to saved file init.vim
C:\Users\you\AppData\Local\nviminit.vim
foo@bar:~$ hp locate example # show full path to saved directory example
C:\Users\you\Documentsexample
You can use `hp` like `cd` to move into directories or edit files in your current directory (so long as the name doesn't conflict with a saved shortcut name).
This will then add that directory to the stored history and allow you to jump to it in the future without adding a shortcut directly.
console
foo@bar:~$ echo $PWD
/home/you/projects/hop
foo@bar:~$ ls .gitignore Cargo.toml README.md src target
foo@bar:~$ hp src [info] Hop created for cargo.
foo@bar:~$ hp history src -> /home/you/projects/hop
foo@bar:~$ cd ...
foo@bar:~$ echo $PWD /home/you/projects
foo@bar:~$ hp src
foo@bar:~$ echo $PWD /home/you/projects/hop/src ```
hop COMMANDSCalling a hp command with a shortcut name or path will attempt to do three things to resolve where it should jump you to:
1) Check if it is within the saved list of shortcuts manually added by the user.
2) Check if it is within the history list of previous hp commands used by the user.
3) Check if it is a valid location within the file system.
Requests to bunnyhop to jump to a new location will check the above three in their listed order and, if it finds a match, will jump to that match.
So if you run a command like hp example, it will first check the saved shortcuts for a shortcut named example. If it finds it, it will move the user to that location or, if that location is a file, open it in the appropriate editor.
If it doesn't find anything in the named shortcuts, it will move on to step 2) where it will check the saved history for a path stored under the name example. If it finds a location stored in history with the name example, it will move the user to that location or open the file in the appropriate editor.
If it doesn't find anything in the stored history, it will finally check if example is a path within the current directory. If it is, it will move the user to that location or open the file in the appropriate editor.
If all of the above steps have failed to find a relevant entry that example represents, it will return a statement like: [error] Unable to execute hop command: Unable to find referenced shortcut.
By default, you can find the configuration file for bunnyhop at ~/.config/bunnyhop/bunnyhop.toml.
Check out the config file to see the current options available and to set your personal editors (default is vi for Unix and notepad for Windows).
Additionally, if you'd to use a location other than the default for your system to store the configuration files and SQLite database, you can set the following environment variables before running bunnyhop.
1) HOP_CONFIG_DIRECTORY - Sets the directory the configuration files will be provisioned in. Defaults to ~/.config/bunnyhop.
2) HOP_CONFIG_FILE_NAME - Sets the actual filename of the configuration file within the config directory. Defaults to bunnyhop.toml.
3) HOP_DATABASE_DIRECTORY - Sets the directory that the SQLite database directory is stored in. Defaults to ~/.config/bunnyhop/db.
4) HOP_DATABASE_FILE_NAME - Sets the actual filename of the SQLite database. Defaults to bunnyhop.db.
Note: It checks these variables every time bunnyhop is called, so if you use a location other than the default you need to ensure the above variables are added to your PATH.
2nd Note: If you change these environment variables after you've already run and set up bunnyhop, you need to copy the files over from their default location and rename them if you want to continue using the same defaults. Otherwise, a new configuration file and a new database will be created.
If you'd like to see what the current configuration and database directories, simple run hp locate from your command line.
If your shell configuration file is set to a non-default location, you can set the following environment variables manually before building bunnyhop and it will configure the runners in the location you set:
1) BUNNYHOP_ZSH_CONFIG_DIR - Directory your .zshrc file is located.
2) BUNNYHOP_BASH_CONFIG_DIR - Directory your .bashrc file is located.
3) BUNNYHOP_NUSHELL_CONFIG_DIR - Directory your nushell env.nu file is located.
4) BUNNYHOP_POWERSHELL_CONFIG_DIR - Directory your powershell profile.ps1 or Microsoft.PowerShell_profile.ps1 files are located.
Once these variables have been set, you must rerun the make command for the shell you're trying to update and it will add the runner function to the appropriate place.
1) Write a more comprehensive suite of unit tests. 2) Add functionality to search stored history for possible locations. 3) Add customized editor launch commands (ie allow flags when calling an editor to open a file). 4) Make a Neovim plugin so I can easily navigate without opening a new terminal panel or closing current terminal panel. 5) Create ability to add shortcuts for groups of files that can be opened together in the editor at the same time.
MIT.
If you have issues or would like some update/improvement, feel free to reach out and file an issue.
(fin.)