uWelcome

uWelcome is a configurable CLI Banner made for your favorite Linux systems!

⚠️ WIP: Some features still need feedback and testing.

Contributions are welcome! If you want to contribute, you're welcome to submit a pull request or open an issue - it's very much appreciated ❤️

Want to configure or contribute to uWelcome ? Take a look at the documentation !

Interessed in the translatable system MOTD instead ? Check umotd

Installation

There are multiple ways to get uWelcome on your machine:

Universal Blue systems

uWelcome is built in Universal Blue systems! It's currently featured in:

• Bluefin Dakota
• Bluefin Utah

uWelcome will get updated with your system.

Homebrew

uWelcome is available on Mimolet's personal tap, you can download it on your system with:

brew tap themimolet/tap
brew trust themimolet/tap
brew install uwelcome

Homebrew allows you to update uWelcome easily, the tap will always feature the latest version.

Download it from the releases page

You can download the latest release from the releases page.

You can then rename it to uwelcome and place it in your usual /bin folder.

Note: You won't receive automatic updates, you will have to download uWelcome at each new release.

Compile from source

You'll need to have go installed on your system first. Then you'll have clone the repository and then build the binary like this:

git clone https://github.com/projectbluefin/uwelcome
cd uwelcome
go build
./uwelcome

You'll then have the uwelcome binary in the current directory, which you can just drop into your usual /bin folder and it will work without any further setup (except for the configuration file if you want to customize it).

Getting started

How to edit uWelcome

Once you have it installed on your system, you'll most likely meet our default configuration or the system configuration when running uwelcome. You can edit the configuration in the terminal with uwelcome edit which will open the configuration file with your default terminal editor.

If you want to know more about the configuration file, check this page out.

Commands

uWelcome supports the following commands:

disable     # Disables the MOTD for the user
edit        # Opens the config file with the default terminal editor
enable      # Enables the MOTD for the user
help        # Shows the available commands
reset       # Resets the config file to the default/system config
status      # Shows the config path and status
toggle      # Toggles the MOTD on/off for the current user
version     # Displays the version of uWelcome currently in use

Learn more in the docs folder !

AI usage

This project had mild AI involvement mainly for auto-completion and AI is still kind of used for code checking, but the code is still written by the hands of an idiot (me :P). The program is always tested before release, no worries. (I have standards >:3)