Showcase

Valet in a gist:

  • In Valet, you can create new commands that you can invoke with valet my-command.
  • Each command has properties that describe it (a description, a list of arguments and options, and so on…).
  • Each command has an associated bash function that is called when the command is invoked and which contains your logic.
  • You define commands and their functions in .sh files under your Valet user directory and Valet takes care of indexing your commands; which allows you to quickly find them, parse options, arguments, print their help…

🖥️ An interactive menu

Invoking valet without arguments lets you interactively search and invoke commands:

demo-menu

📖 Clear and standardized help

With valet command --help or valet help command, you get a beautifully formatted help for your command usage:

demo-help

Fuzzy matching command names allow you to invoke the right command more quickly, see this example with valet h s h:

🔎 Fuzzy matching

demo-fuzzy

🧪 Test framework

Automate tests for your script with approval test approach:

demo-tests

🐾 Logging library

Get beautiful logs fully customizable (with optional wrapping!):

demo-logs

🪄 Auto parser

Auto parsing of arguments and options based on your command configuration:

demo-parsing

🧩 Libraries of function

Make your scripts more performant and write code faster by using Valet libraries for string manipulation, interactive prompt, pure bash I/O and more… Some examples:

script.sh
1
2
3
4
5
6
7
8

myFunction() {
  source string
  string::cutField "field1 field2 field3" 1 " " && echo "The field at index 1 is ${RETURNED_VALUE}"
  string::extractBetween "<html><b>Bold value</b></html>" "<b>" "</b>" && echo "The extracted value is ${RETURNED_VALUE}" 

  source interactive
  if interactive::promptYesNo "Do you want to continue?"; then echo "Yes."; else echo "No."; fi
}
ℹ️
This showcase was recorded with the windows terminal, debian on WSL with zsh & oh my zsh. The color scheme for the terminal is dracula and the font is a homemade modification of windows Consolas (with ligatures + with nerd font icons).
Ready to get started?
Check out the documentation