๐Ÿ’ป Installation

๐Ÿ’ป Installation

๐Ÿ“ฆ Dependencies

  • Bash version 5 or superior is required (might work with older versions but it is not guaranteed).
  • From GNU coreutils: it uses rm, mv, mkdir for all commands. It uses cp, chmod, touch for the installation/updates. You most likely already have all of these!
  • curl and tar are needed only if you want to use the self-update command.

๐Ÿšš Automated installation

Run the following command to install Valet:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/jcaillon/valet/latest/valet.d/commands.d/self-install.sh)"
๐Ÿ’ก
Please review the [installation script][selfInstallScriptLink] or the [self install command usage][selfInstallCommandUsageLink] to learn about the different installer options.

Here is an example command to install Valet with the option --unattended:

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

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!

๐ŸชŸ Use Valet on windows

It is recommended to use Git bash, installed with Git for Windows 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.

๐Ÿ’ก
Alternatively, use docker run --rm -it noyacode/valet to pull and run the image stored on DockerHub.