https://github.com/wervice/salut
Salut is a beautiful terminal greeter
https://github.com/wervice/salut
cpp shell terminal theming
Last synced: about 1 year ago
JSON representation
Salut is a beautiful terminal greeter
- Host: GitHub
- URL: https://github.com/wervice/salut
- Owner: Wervice
- License: mit
- Created: 2025-03-11T15:50:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-11T16:25:06.000Z (about 1 year ago)
- Last Synced: 2025-03-11T17:26:58.546Z (about 1 year ago)
- Topics: cpp, shell, terminal, theming
- Language: C++
- Homepage:
- Size: 91.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Salut
## A beautiful terminal greeter 🌸
Salut is a simple yet beautiful terminal greeter.
To use it, simply attach the path of the salut binary to the top of your shell config file.
Salut will then launch, everytime you open your shell.
### Installation
Salut does not come pre-built for any distributions.
You have to build it your self.
1. Clone this repository
`git clone https://github.com/Wervice/salut`
2. Compile and run the source code
a) Using GCC
`g++ -o salut main.cpp -lfmt && ./salut`
b) Using Clang
`clang++ -o salut main.cpp -lfmt && ./salut`
c) If you are on NixOS
`nix-shell`
3. Copy the executable somewhere else
I recommend moving the executable into a folder in your `$PATH`, but you can choose any location you like.
4. Add `salut` binary path to your config file
Depending on your shell, your config file may be called:
- `.zshrc`
- `.bashrc`
5. Salut will now launch every time you open a new shell
### Usage
To keep salut open, you need to press `:` one time, before you can do anything.
If you do not press `:`, the splash screen will instantly close at the first key press and leave your default shell.
Salut uses a command line at the bottom of your terminal for inputs. You do not need to enter the `:` when writing commands.
You run the programs in the list by entering their corresponding command.
By default the following commands are implemented:
|Command|Action|
|-------|------|
|`q` |Exits salut|
|`h` |Shows help|
|`main` |Returns to main screen|
|`nv` |Opens neovim|
|`ft ` |Opens fastfetch|
|`bs` |Starts bash|
|`bp` |Opens btop|
### Configuration
Salut does not feature a config file. Thus, you have to edit the source code to modify `salut`.
To set your own applications, edit the `options` variable in `int main`.
You can change the `prefix` char using the prefix variable.
```cpp
vector> options = {
make_tuple("Neovim", " ", "nv", "nvim"),
make_tuple("Fastfetch", " ", "ft", "fastfetch"),
make_tuple("Bash", " ", "bs", "bash"),
make_tuple("Btop", " ", "bp", "btop"),
};
```
Just copy-'n-paste a line and edit it to create a new link.
Please note, that `salut` will not display links or ascii art if the terminal is to small.
### The name
The name of `salut` comes from the french "salut", which means "Hi".
It is pronouced without the t in the end.