tuigreet - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #llm #rust #deep-learning #macos #java #vue #pytorch #ios #open-source

tuigreet

(★ 115)

Stylish graphical console greeter for greetd, built with Ratatui

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
- - nix.yml
  - pr.yml
  - release.yml
  - rust.yml
- dependabot.yml
- FUNDING.yml
- - screenshot-themed.png
  - screenshot.png
- - group
  - passwd
- - tuigreet-1.scd
- example.config.toml
- - build.rs
  - Cargo.toml
- - Cargo.toml
- - Cargo.toml
  - i18n.toml
- - Cargo.toml
- - Cargo.toml
- - Cargo.toml
- - default.nix
- package.nix
- shell.nix
.envrc
.gitignore
.rustfmt.toml
.taplo.toml
Cargo.lock
Cargo.toml
CHANGELOG.md
flake.lock
flake.nix
LICENSE
README.md
rust-toolchain.toml

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/NotAShelf/tuigreet

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd tuigreet

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Rust

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

$ cargo build --release

Rust 프로젝트를 컴파일합니다.

$ LD_PRELOAD=/path/to/libnss_wrapper.so cargo test --features nsswrapper nsswrapper_ # to run those tests specifically

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ LD_PRELOAD=/path/to/libnss_wrapper.so cargo test --all-features # to run the whole test suite

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tuigreet

[greetd]: https://git.sr.ht/~kennylevinsen/greetd
[tuigreet]: https://github.com/apognu/tuigreet
[the original author or tuigreet]: https://github.com/apognu
[merged back into tuigreet]: https://github.com/tuigreet/tuigreet/pull/211

Stylish, modern and extensible greeter for [greetd], built on top of the
original [tuigreet] foundation with a focus on improved maintainability, a
cleaner codebase, and a more polished user experience.

> [!IMPORTANT]
> As of 12.08.2025, following a discussion with
> [the original author or tuigreet] this fork has been **consolidated back into
> the original repo**. This fork has now been archived, and all changes have
> been [merged back into tuigreet]. Please ask your distro packagers to update
> the repository location and update to the new release if you are interested in
> the changes spearheaded by this fork.

## Features

tuigreet provides a terminal-based authentication interface with session
management, user selection, and power controls. The upstream project includes
session launching from desktop files, username/session persistence, NSS-backed
user menus, themeable UI components, and multi-language support.

This fork, as per its motivation to maintain tuigreet with much-desired features
and stability, extends the original with TOML-based configuration (supporting
both user and system config files with hot-reload), environment variable mapping
for all options, detailed error messages with source context for config issues,
multi-monitor terminal sizing (sizing the TTY to match a specific connected
display via DRM), and exposes core functionality as a library. Some issues that
are fixed from upstream are as follows.

- [tuigreet#156](https://github.com/apognu/tuigreet/issues/156)
- [tuigreet#172](https://github.com/apognu/tuigreet/issues/172)
- [tuigreet#178](https://github.com/apognu/tuigreet/issues/178)
- [tuigreet#190](https://github.com/apognu/tuigreet/issues/190)

Additional, and perhaps marginally less relevant work includes includes a bump
to the Rust edition, MSRV changes, dependency updates, a deep scrub to the
codebase, NixOS VM-based integration tests and other bugfixes such as but not
limited to session wrapper behavior, UID handling, padding semantics, status bar
rendering and so on.

We also port _some_ of the previously open PRs, such as:

- [tuigreet#94](https://github.com/apognu/tuigreet/pull/94)

## Usage

![Screenshot of tuigreet authentication interface](https://github.com/notashelf/tuigreet/blob/master/contrib/assets/screenshot.png)

The default configuration of tuigreet is quite minimal, visually speaking. It
only displays the authentication prompt and some minor information in the status
bar. You may additionally print your system's `/etc/issue` at the top of the
prompt with `--issue`, and the current date & time using `--time`. The time can
also be customized with the `--time-format` flag. It is also possible to include
a custom, one-line greeting message _instead of_ `/etc/issue` using the
`--greeting` flag.

### Prompt Customization

The initial prompt container will be 80 columns wide. You might want to change
this using the `--width` flag in the case you need more space, e.g., to account
for larger PAM challenge messages. Please refer to usage information (`--help`)
for more customization options. Various padding settings are available through
the `*-padding` options.

### Session Persistence

You can instruct `tuigreet` to remember the last username that successfully
opened a session with the `--remember` option (that way, the username field will
be pre-filled). Similarly, the command and session configuration can be retained
between runs with the `--remember-session` option (when using this, the `--cmd`
value is overridden by manual selections). You can also remember the selected
session per user with the `--remember-user-session` flag. In this case, the
selected session will only be saved on successful authentication.

You may change the command that will be executed after opening a session by
hitting `F2` and amending the command. Alternatively, you can list the
system-declared sessions (or custom ones) by hitting `F3`. Power options are
available through `F12`.

### Background animations

tuigreet can paint an animated backdrop behind the login form. Animations are
off by default and selected by name with `--background <name>`, or by setting
`kind` in the `[background]` section of your config file. The login form is
drawn on top of the animation and clears the cells it occupies, so the prompt
remains legible regardless of what the backdrop is doing.

Frame rate is configurable through `--background-fps`, and defaults to 30 FPS
while an animation is active (the UI otherwise ticks at the usual 2 FPS).
Setting `--background none` (or omitting the flag) disables the feature
entirely, in which case there is no per-frame cost.

The following animation is available out of the box:

- `doom` - The classic DOOM fire effect. Two parameters control the shape of the
  flames: `--doom-height` (decay control, 1–9, default `6`) makes flames taller
  at higher values, and `--doom-spread` (horizontal jitter, 0–4, default `2`)
  widens them. The three color bands are set together with
  `--doom-colors TOP,MIDDLE,BOTTOM`; each accepts `#RRGGBB`, `0xRRGGBB`, or any
  named color.
- `matrix` - Falling green digital rain. Stream length is set with
  `--matrix-length MIN,MAX` (rows, default `6,18`) and fall speed with
  `--matrix-speed MIN,MAX` (rows-per-frame, default `0.30,1.10`); the three
  color bands are set together with `--matrix-colors HEAD,BRIGHT,DIM`.

You can also switch animations on the fly without restarting the greeter by
hitting `F4`. This opens a small menu listing every available animation plus a
`None` entry to disable the backdrop; selection rebuilds the active animation
with that kind's default options. The hotkey is configurable through
`--kb-background` or the `background` field of the `[keybindings]` section, the
same way the existing F2/F3/F12 menus are configured.

## Installing Tuigreet

[releases tab]: https://github.com/NotAShelf/tuigreet/releases/latest

There are various methods of installing Tuigreet, and you're recommended to pick
the appropriate method for your distribution or preferred package manager. We
provide pre-built binaries for tagged releases, which can be obtained from the
[releases tab]. Additionally, the maintainers of this project maintain packages
for the Arch Linux AUR and Nix via flakes. If none of those interest you, you
may build from source. Should you wish to package this for your distribution,
please do, and submit a pull request to update the readme with per-distribution
instructions. We will be happy to review :)

### From the AUR

[AUR]: https://aur.archlinux.org/packages?O=0&K=tuigreet-fork

On ArchLinux, two distributions are available from the [AUR].
`greetd-tuigreet-fork-bin` is the precompiled binary for the latest tagged
release, and `greetd-tuigreet-fork-git` is available for the same tagged
release, but you compile it yourself from the latest commit Those can be
installed via your preferred AUR helper, e.g.:

```bash
# Install the built binary from the AUR. This uses tuigreet's own releases.
$ yay -S greetd-tuigreet-fork-bin

# Alternatively, use the -git version to build from source. This depends on
# the Rust toolchain.
$ yay -S greetd-tuigreet-fork-git
```

### With Nix

The primary method of installing tuigreet and even developing it is _Nix_. We
provide a Nix flake to build the package from source using Nix. The easiest way
of using the flake would be to create an overlay for yourself, overriding
`pkgs.tuigreet` with the flake package. Simply point `tuigreet` to
`inputs.tuigreet.packages.${prev.hostPlatform.system}.tuigreet` instead of
overriding the `src`. This will completely replace the derivation, and build
with the correct source automatically. In most cases **this is preferred to
overwriting the Nixpkgs derivation**.

This fork is not packaged in Nixpkgs, but it is trivial to use the Nixpkgs
derivation with the updated source information, should you wish to run it. For
example, you may create an overlay to override `pkgs.tuigreet` as follows:

```nix
[
  (final: prev: {
    tuigreet = prev.tuigreet.overrideAttrs (
      finalAttrs: prevAttrs: {
        version = "0.11.0"; # remember to update this version!

src = final.fetchFromGitHub {
          inherit (prevAttrs.src) repo;
          owner = "NotAShelf";
          # update this with the tag you want to use, if ≠'version'
          tag = finalAttrs.version;
          # update this with the appropriate hash for your tag
          hash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
        };

cargoDeps = final.rustPlatform.fetchCargoVendor {
          inherit (finalAttrs) src;
          # update this with the appropriate cargo dependencies hash
          hash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
        };
      }
    );
  }
]
```

Please keep in mind that packaging steps might change in the future. You are
encouraged to use the package provided by the flake unless you have a really
good reason not to.

### From source

Building Tuigreet from source requires an installation of Rust's stable
toolchain. Currently 1.90 and above is required. You may use the Nix devshell
provided by the repository, or install it using something like `rustup`.

```sh
# Clone the repository and navigate to it
$ git clone https://github.com/NotAShelf/tuigreet && cd tuigreet

# Build in release mode
$ cargo build --release

# You may then move it to somewhere you can use it. If on NixOS, refer to above
# steps instead of trying to copy the binary.
# $ mv target/release/tuigreet /usr/local/bin/tuigreet
# You can also use cargo to build and install from Git:
# $ cargo install --git https://github.com/notashelf/stash --locked
```

> [!NOTE]
> Cache directory must be created for `--remember*` features to work. The
> directory must be owned by the user running the greeter. This is handled
> automatically if using the NixOS module in Nixpkgs.

```bash
# If cache is missing or owned by the wrong user, you may run the following
# commands to create it, or to fix the permissions.
$ mkdir /var/cache/tuigreet
$ chown greeter:greeter /var/cache/tuigreet
$ chmod 0755 /var/cache/tuigreet
```

### Pre-built binaries

[releases]: https://github.com/NotAShelf/tuigreet/releases

Pre-built binaries of `tuigreet` for several architectures can be found in the
[releases] section of this repository. You may download a binary for your
architechture, and add it to your `PATH` to make it available on your system.

## Configuration

Edit `/etc/greetd/config.toml` and set the `command` setting to use `tuigreet`:

```toml
[terminal]
vt = 1

[default_session]
command = "tuigreet --cmd sway"
user = "greeter"
```

Please refer to [greetd's wiki](https://man.sr.ht/~kennylevinsen/greetd/) for
more information on setting up `greetd`.

### TOML Configuration

`tuigreet` supports TOML configuration files in addition to command-line
options. Configuration files are loaded from:

1. `~/.config/tuigreet/config.toml` (user config)
2. `/etc/tuigreet/config.toml` (system config)
3. Custom path via `--config <path>`

Configuration priority: CLI args > environment variables > user config > system
config > defaults

#### Configuration Example

```toml
[display]
show_time = true
greeting = "Welcome to the system!"
align_greeting = "center"
issue = false

[layout]
width = 60
window_padding = 2
container_padding = 1
prompt_padding = 1

[layout.widgets]
time_position = "top"      # "top", "bottom", "default", "hidden"
status_position = "bottom" # "top", "bottom", "default", "hidden"

[remember]
username = true
session = false
user_session = true

[user_menu]
enabled = true
min_uid = 1000
max_uid = 60000

[secret]
mode = "characters"  # "hidden" or "characters"
characters = "*"

# `[display] asterisks = true|false` remains supported for compatibility but is
# deprecated. Migrate it to `secret.mode`; `secret.mode` wins if both are set.

[keybindings]
command = 2     # F2
sessions = 3    # F3
background = 4  # F4
power = 12      # F12

[background]
kind = "doom"        # or "none" to disable
fps = 30

[background.doom]
height = 6           # 1-9, taller flames at higher values
spread = 2           # 0-4, horizontal jitter
top_color = "#9F2707"
middle_color = "#C78F17"
bottom_color = "#FFFFFF"

[background.matrix]
head_color = "#CCFFCC"
bright_color = "#33FF66"
dim_color = "#006622"
min_length = 6
max_length = 18
min_speed = 0.30     # rows per frame
max_speed = 1.10
mutate_chance = 0.02 # per-cell glyph shimmer probability

[session]
sessions_dirs = ["/usr/share/wayland-sessions", "/usr/share/xsessions"]
xsessions_dirs = []
environments = []

[power]
use_setsid = false

[theme]
border = "white"
text = "green"
time = "blue"
container = "black"
title = "cyan"
greet = "yellow"
prompt = "magenta"
input = "white"
action = "bright-blue"
button = "bright-red"
```

#### Environment Variables

All configuration options can also be set via environment variables. The naming
convention is `TUIGREET_<SECTION>_<KEY>` for nested options, or `TUIGREET_<KEY>`
for top-level options:

```bash
# General configuration
export TUIGREET_DEBUG=true
export TUIGREET_LOG_FILE="/custom/path/tuigreet.log"

# Display options
export TUIGREET_TIME=true
export TUIGREET_TIME_FORMAT="%Y-%m-%d %H:%M"
export TUIGREET_GREETING="Welcome!"
export TUIGREET_ISSUE=false
export TUIGREET_ALIGN_GREETING=center  # left, center, right

# Layout configuration
export TUIGREET_WIDTH=80
export TUIGREET_WINDOW_PADDING=1
export TUIGREET_CONTAINER_PADDING=1
export TUIGREET_PROMPT_PADDING=1

# Widget positioning
export TUIGREET_TIME_POSITION=top      # default, top, bottom, hidden
export TUIGREET_STATUS_POSITION=bottom # default, top, bottom, hidden

# Remember options
export TUIGREET_REMEMBER=true
export TUIGREET_REMEMBER_SESSION=false
export TUIGREET_REMEMBER_USER_SESSION=true

# User menu configuration
export TUIGREET_USER_MENU=true
export TUIGREET_USER_MENU_MIN_UID=1000
export TUIGREET_USER_MENU_MAX_UID=60000

# Secret display
export TUIGREET_SECRET_MODE=characters  # hidden, characters
export TUIGREET_SECRET_CHARACTERS="●"

# Session configuration
export TUIGREET_SESSION_COMMAND="sway"
export TUIGREET_SESSIONS_DIRS="/usr/share/wayland-sessions:/custom/sessions"
export TUIGREET_XSESSIONS_DIRS="/usr/share/xsessions"
export TUIGREET_SESSION_WRAPPER="systemd-cat -t sway"
export TUIGREET_XSESSION_WRAPPER="startx"
export TUIGREET_ENVIRONMENTS="WAYLAND_DISPLAY:DISPLAY"

# Power options
export TUIGREET_POWER_USE_SETSID=false

# Keybindings (F-key numbers)
export TUIGREET_KB_COMMAND=2   # F2
export TUIGREET_KB_SESSIONS=3  # F3
export TUIGREET_KB_POWER=12    # F12

# Individual theme components
export TUIGREET_THEME_BORDER=white
export TUIGREET_THEME_TEXT=green
export TUIGREET_THEME_TIME=blue
export TUIGREET_THEME_CONTAINER=black
export TUIGREET_THEME_TITLE=cyan
export TUIGREET_THEME_GREET=yellow
export TUIGREET_THEME_PROMPT=magenta
export TUIGREET_THEME_INPUT=white
export TUIGREET_THEME_ACTION=bright-blue
export TUIGREET_THEME_BUTTON=bright-red

# Or use legacy theme format (semicolon-separated)
export TUIGREET_THEME="border=white;text=green;time=blue;container=black"
```

#### Hot Reload

Configuration files are automatically monitored for changes and hot-reloaded
when modified. This allows you to adjust settings without restarting the
greeter.

#### Configuration Errors

tuigreet makes an effort to include detailed context with line numbers and
source code snippets to help identify and fix configuration issues. For example:

```plaintext
error[TOML001]: TOML parse error at line 2: extra `=`, expected nothing
  ┌─ config.toml:2:9
  │
2 │ width = = 123
  │         ^ extra `=`, expected nothing

error[TOML001]: TOML parse error at line 1: unclosed table, expected `]`
  ┌─ extra.toml:1:9
  │
1 │ [session
  │         ^ unclosed table, expected `]`

error[TOML001]: TOML parse error at line 2: key with no value, expected `=`
  ┌─ theme.toml:2:5
  │
2 │ key with space = true
  │     ^ key with no value, expected `=`
```

### Multi-monitor Support

On multi-monitor setups the Linux virtual console may span all connected
displays, leaving the greeter rendered across a larger-than-intended area.
tuigreet can resize the TTY to match the native resolution of a specific monitor
by reading connector information from `/sys/class/drm/` and applying the new
dimensions via `TIOCSWINSZ` before the TUI starts.

To see which connectors are available on your system, run:

```sh
tuigreet --list-outputs
```

Then declare the target display in your config. Mark one output `primary = true`
to use it for sizing; if none is marked primary the first enabled entry is used.
Disable any outputs you do not want to affect sizing with `enabled = false`:

```toml
[[outputs]]
connector = "DP-1"
primary = true

[[outputs]]
connector = "HDMI-A-1"
enabled = false
```

If you already know the exact character-cell dimensions you want (e.g. from a
fixed font size), you can bypass the DRM detection entirely with an explicit
override. Both `cols` and `rows` must be provided together:

```toml
[terminal]
cols = 237
rows = 52
```

`[terminal]` takes precedence over `[[outputs]]` when both are set.

### Sessions

The available sessions are fetched from `desktop` files in
`/usr/share/xsessions` and `/usr/share/wayland-sessions`. If you want to provide
custom directories, you can set the `--sessions` arguments with a
colon-separated list of directories for `tuigreet` to fetch session definitions
some other place.

#### Desktop environments

`greetd` only accepts environment-less commands to be used to start a session.
Therefore, if your desktop environment requires either arguments or environment
variables, you will need to create a wrapper script and refer to it in an
appropriate desktop file.

For example, to run X11 Gnome, you may need to start it through `startx` and
configure your `~/.xinitrc` (or an external `xinitrc` with a wrapper script):

```plaintext
exec gnome-session
```

To run Wayland Gnome, you would need to create a wrapper script akin to the
following:

```bash
XDG_SESSION_TYPE=wayland dbus-run-session gnome-session
```

Then refer to your wrapper script in a custom desktop file (in a directory
declared with the `-s/--sessions` option):

```plaintext
Name=Wayland Gnome
Exec=/path/to/my/wrapper.sh
```

#### Common wrappers

Two options allows you to automatically wrap run commands around sessions
started from desktop files, depending on whether they come
`/usr/share/wayland-sessions` or `/usr/share/xsessions`: `--sessions-wrapper`
and `--xsessions-wrapper`. With this, you can prepend another command on front
of the sessions you run to set up the required environment to run these kinds of
sessions.

By default, unless you change it, all X11 sessions (those picked up from
`/usr/share/xsessions`) are prepended with `startx /usr/bin/env`, so the X11
server is started properly.

### Power management

Four power actions are possible from `tuigreet`: shutting down (through
`shutdown -h now`), rebooting (with `shutdown -r now`), suspending (with
`loginctl suspend`) and hibernating (with `loginctl hibernate`) the machine.
This requires that those commands be executable by regular users, which is not
the case on some distros. `loginctl` is provided by both systemd and elogind, so
the suspend and hibernate defaults work on non-systemd distributions as well.

To alleviate this, there are options to customize the commands that are run:
`--power-shutdown`, `--power-reboot`, `--power-suspend` and `--power-hibernate`.
The provided commands must be non-interactive, meaning they will not be able to
print anything or prompt for anything. If you need to use `sudo` or `doas`, they
will need to be configured to run passwordless for those specific commands.

An example for `/etc/greetd/config.toml`:

```toml
[default_session]
command = "tuigreet --power-shutdown 'sudo systemctl poweroff'"
```

> [!NOTE]
> By default, all commands are prefixed with `setsid` to completely detach the
> command from our TTY. If you would prefer to run the commands as is, or if
> `setsid` does not exist on your system, you can use `--power-no-setsid`.

### User menu

Optionally, a user can be selected from a menu instead of typing out their name,
with the `--user-menu` option, this will present all users returned by NSS at
the time `tuigreet` was run, with a UID within the acceptable range. The values
for the minimum and maximum UIDs are selected as follows, for each value:

- A user-provided value, through `--user-menu-min-uid` or `--user-menu-max-uid`;
- **Or**, the available values for `UID_MIN` or `UID_MAX` from
  `/etc/login.defs`;
- **Or**, hardcoded `1000` for minimum UID and `60000` for maximum UID.

### Theming

[in the ratatui repository]: https://github.com/ratatui/ratatui/blob/main/ratatui-core/src/style/color.rs

A theme specification can be given through the `--theme` argument to control
some of the colors used to draw the UI. This specification string must have the
following format: `component1=color;component2=color[;...]` where the component
is one of the value listed in the table below, and the color is a valid ANSI
color name as listed [in the ratatui repository].

Mind that the specification string include semicolons, which are command
delimiters in most shells, hence, you should enclose it in single-quotes so it
is considered a single argument instead.

Please note that we can only render colors as supported by the running terminal.
In the case of the Linux virtual console, those colors might not look as good as
one may think. Your mileage may vary.

| Component name | Description                                                                        |
| -------------- | ---------------------------------------------------------------------------------- |
| text           | Base text color other than those specified below                                   |
| time           | Color of the date and time. If unspecified, falls back to `text`                   |
| container      | Background color for the centered containers used throughout the app               |
| border         | Color of the borders of those containers                                           |
| title          | Color of the containers' titles. If unspecified, falls back to `border`            |
| greet          | Color of the issue of greeting message. If unspecified, falls back to `text`       |
| prompt         | Color of the prompt ("Username:", etc.)                                            |
| input          | Color of user input feedback                                                       |
| action         | Color of the actions displayed at the bottom of the screen                         |
| button         | Color of the keybindings for those actions. If unspecified, falls back to `action` |

Below is a screenshot of the greeter with the following theme applied:

```plaintext
`border=magenta;text=cyan;prompt=green;time=red;action=blue;button=yellow;container=black;input=red`:
```

Which results in the following:

![Screenshot of tuigreet](https://github.com/NotAShelf/tuigreet/blob/master/contrib/assets/screenshot-themed.png)

### Visual mock-up mode

For previewing themes, animations, or layout changes without a running greetd,
pass `--mock`. tuigreet will run as normal, but emulate auth flow locally.

```sh
tuigreet --mock
```

`GREETD_SOCK` does not need to be set in this mode.

## Running the tests

Tests from the default features should run without any special consideration by
running `cargo test`.

If you intend to run the whole test suite, you will need to perform some setup.
One of our features uses NSS to list and filter existing users on the system,
and in order not to rely on actual users being created on the host, we use
[libnss_wrapper](https://cwrap.org/nss_wrapper.html) to mock responses from NSS.
Without this, the tests would use the real user list from your system and
probably fail because it cannot find the one it looks for.

```bash
# After installing `libnss_wrapper` on your system (or compiling it to get the`.so`)
# you can run those specific tests as such:
$ export NSS_WRAPPER_PASSWD=contrib/fixtures/passwd
$ export NSS_WRAPPER_GROUP=contrib/fixtures/group
$ LD_PRELOAD=/path/to/libnss_wrapper.so cargo test --features nsswrapper nsswrapper_ # to run those tests specifically
$ LD_PRELOAD=/path/to/libnss_wrapper.so cargo test --all-features # to run the whole test suite
```

## License

Following the original source, this project is made available under GNU General
Public License version 3 (GPLv3). See [LICENSE](LICENSE) for more details on the
exact conditions. An online copy is provided
[here](https://www.gnu.org/licenses/gpl-3.0.en.html).

### Attributions

This repository has been forked from [tuigreet] due to the upstream inactivity,
and the following radio silence due to the upstream inactivity, and the
following radio silence. While I do hope that upstream comes back alive
eventually, I have elected to maintain this fork for the time being, and I will
_likely_ continue to do so for the foreseeable future due to my personal gripes
with the previous state of the codebase. In short, this repository has been
created as a fork to maintain tuigreet within my own time while incrementally
improving the codebase, merging old PRs that have been stale for too long,
fixing bugs and adding more features as I need them. Ultimately, I've "upgraded"
the fork status to become almost entirely standalone with drastic refactors on
the codebase. _If_ you are interested in using this fork, great. Let me know
what you need, and I'll see what I can do for you. If you want to contribute,
that's even better! Open a PR, and let's see where it takes us.

A big thank you to the [original author](https://github.com/apognu) for their
excellent efforts on tuigreet. While the upstream remains silent at the time of
writing, it has served as a great base for this fork and ultimately the greeter
it has evolved to be. I also want to extend my changes to any and all
contributors who have supported tuigreet through issues and pull request on both
repositories.