Skip to content

stx3plus1/strlx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

strlx

A "getting started" guide for version 3.0.

Basics

strlx prints a message along with your system information by default.

Usage

strlx <string>

strlx will display your string in the information. If there is none parsed, a random (sometimes a bit odd) default will show.

Strings do not require quotes - strlx prints the entirely of argv - but using them is good practice.

Installation

There are 2 methods for installation - compiling manually, or grabbing the latest release from Releases.

Run chmod +x <the executable> to mark it as executable, if you cannot run it (ex [shell] - Killed [shell]: permission denied).

You can install it properly by copying it to /usr/local/bin (sudo cp strlx /usr/local/bin)

strlx will automatically write a configuration file on first run and you can modify this later.

Compile

strlx is designed for Linux. Success on Linux-like operating systems CAN happen, but macOS is no longer supported.

Remember to set CC to your compiler if you aren't using gcc and your compiler does not provide it.

sudo make install

to compile then add to /usr/local/bin. Add /usr/local/bin to PATH to ensure strlx can be found after.

Configuration

strlx looks in ~/.config/strlx/config.json, where ~ is the home directory.

The file works like this:

The ASCII logo is set with the "ascii" key - which can be "apple", "tux" or "auto". 3.0 revisions will introduce more!

The color is set with the "color" key, which is any hex encoded RGB color with or without a # symbol.

"items" contains your items to fetch with. This is where you put all "inf" or "pri" items.

"pri" allows you to print preset custom messages, the only input is the text in the key option.

"inf" is where all the fetch modules are. There are quite a few, so here they are:

  • syst (user@localhost)

  • dist (Arch Linux, ...)

  • krnl (Linux, version X)

  • shll (bash, zsh...)

  • proc (Intel Core iX, AMD Ryzen X, ...)

  • uptm (5h 10m...)

  • memr (43.24GB / 0.01GB)

Finally... "str", which displays the string of choice from either 2 sets of built in strings, or your own input.