💻 Installation

📦 Dependencies

• Bash version 5 or superior is required (it uses bash EPOCHREALTIME among other features introduced in bash 5).
• GNU coreutils: valet uses rm, mv, cp, mkdir as they can’t be done in pure bash. It also uses chmod, touch for the installation/updates.
• curl and tar: needed only if you want to use the self update or self extend command.

Other external programs can be used if found but are not required¹.

🚚 Automated installation

Run the following command to install Valet:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/jcaillon/valet/latest/commands.d/self-install.sh)"

Here is an example command to install Valet with the options --unattended --single-user-installation (no interactive prompt during installation and installs itself in the home directory of the user):

bash -c "$(curl -fsSL https://raw.githubusercontent.com/jcaillon/valet/latest/commands.d/self-install.sh)" -s --unattended --single-user-installation

Finally, call valet to get started with the example commands!

🪛 Manual installation

1. Download the package from the latest release from GitHub.
2. Extract the archive to your favorite installation directory.
3. Add this directory to your PATH so you can call valet from your terminal.
4. Call valet to get started with the example commands!

🔨 Manual installation from sources

1. You can clone this project or download the source from the latest release into the directory of your choice.
2. Add this directory to your PATH so you can call valet from your terminal.
3. Call valet to get started with the example commands!

⚙️ Extra config for your terminal

• Nerd font: Valet can make use of Nerd fonts to display icons in the logs and interactive sessions. You can download any nerd font from here, install it, and configure your terminal to use that font. The demos you saw in the landing page are done with JetBrainsMono Nerd Font.
• Word separator: Valet usually prints important values between ⌜quotes⌝ using the UTF8 top left and top right corners (respectively U+231C and U+231D). You can add these two characters as word separators in your terminal for quick double click selection: ⌜⌝.

🪟 Use Valet on windows

It is recommended to use Git bash, installed with Git for Windows (or msys2) and Windows terminal as your terminal program. You can also use Valet with any Linux distribution and Windows Subsystem for Linux (WSL).

🐋 Run Valet in a container

With a container engine (such as Docker or Podman), you can run a containerized version of Valet:

docker run --rm -it ghcr.io/jcaillon/valet

Find the list of image tags under Valet packages.