rund

A simple shell hook to run commands on directory change for Fish, Bash, and Zsh.

Screen.Recording.2024-04-04.at.18.38.55.mov

Installation

For Fish:

fisher install marcelarie/rund

For Bash and Zsh, clone the repository and run the install script:

git clone https://github.com/marcelarie/rund.git
cd rund
sudo ./install.sh

Usage

rund will automatically check for a Runfile file in the current directory and source the commands in it, if the user already approved it with rund allow.

If you did not use a plugin manager to install rund, you will need to source it in your shell.

For Fish: Add the following line to your config.fish file:

rund fish | source

For Bash: Add the following line to your .bashrc file:

source rund bash

For Zsh: Add the following line to your .zshrc file:

source $(rund zsh)

rund will check automatically for a Runfile file in the current directory and source the commands in it.

Lets say you have a Runfile file in your project directory with the following content:

#!/usr/bin/env bash

echo "                🏃"
sleep 0.1
clear
echo "              🏃  "
sleep 0.1
clear
echo "            🏃    "
sleep 0.1
clear
echo "          🏃      "
sleep 0.1
clear
echo "        🏃        "
sleep 0.1
clear
echo "      🏃          "
sleep 0.1
clear
echo "    🏃            "
sleep 0.1
clear
echo "  🏃              "
sleep 0.1
clear
echo "🏃                "
clear

What will happen is that every time you cd into the directory for the first time, you will have a beautiful running emoji in your terminal.

rund keeps track of the directories and shell session to run the commands only the first time you cd into the directory on that session.

If you are concerned about security, don't worry. rund will prompt you to allow the commands in the Runfile file before running them.

Simply type rund allow in the root of the project directory and the commands will be executed from now on.

Of course, this is a very simple example. You can have more complex commands for example to start a development server, run tests, etc.

Enjoy!

To Do

• Fix Runfile file running in non user shells For example when using pbcopy inside nvim.

• Don't run the commands if the Runfile file has not been approved by the user.

  • Don't run the info message if the Runfile file has not been approved by the user. the user every time the shell runs a command.
  • Implement in fish
  • Implement in bash
  • Implement in zsh