Graphical console greeter for greetd
Go to file
2020-06-29 17:37:27 +02:00
.github/workflows Added a short option for the width argument. Added usage and build instructions to README. 2020-06-29 17:37:27 +02:00
contrib Basic working functionality. 2020-06-27 14:54:30 +02:00
src Added a short option for the width argument. Added usage and build instructions to README. 2020-06-29 17:37:27 +02:00
.gitignore Basic working functionality. 2020-06-27 14:54:30 +02:00
.rustfmt.toml Refactored code and applied rustfmt. 2020-06-28 13:09:12 +02:00
Cargo.lock Renamed project to tuigreet. 2020-06-28 17:18:43 +02:00
Cargo.toml Renamed project to tuigreet. 2020-06-28 17:18:43 +02:00
LICENSE Conforming to greetd license until a better alternative is found. tuigreet is now GPLv3. 2020-06-29 17:34:36 +02:00
README.md Added a short option for the width argument. Added usage and build instructions to README. 2020-06-29 17:37:27 +02:00

tuigreet

Graphical console greeter for greetd.

Screenshot of tuigreet

Usage: tuigreet [OPTIONS]

Options:
    -h, --help          show this usage information
    -c, --cmd COMMAND   command to run
    -w, --width WIDTH   width of the main prompt (default: 80)
    -i, --issue         show the host's issue file
    -g, --greeting GREETING
                        show custom text above login prompt
    -t, --time          display the current date and time

Usage

The default configuration tends to be as minimal as possible, visually speaking, only showing the authentication prompts and some minor information in the status bar. You may print your system's /etc/issue at the top of the prompt with --issue and the current date and time with --time. You may include a custom one-line greeting message instead of /etc/issue with --greeting.

The initial prompt container will be 80 column wide. You may change this with --width in case you need more space (for example, to account for large PAM challenge messages).

You may change the command that will be executed after opening a session by prefixing it with ! in the username input box, for example !bash.

Install

From source

Building from source requires an installation of Rust's stable toolchain, including cargo.

$ git clone https://github.com/apognu/tuigreet && cd tuigreet
$ cargo build --release
# mv target/release/tuigreet /usr/local/bin/tuigreet

Pre-built binaries

Pre-built binaries of tuigreet for several architectures can be found in the releases section of this repository. The tip prerelease is continuously built and kept in sync with the master branch.

Actual tag releases will be created when the project stabilizes.

Configuration

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

[terminal]
vt = 1

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

Please refer to greetd's wiki for more information on setting up greetd.