rinfo

Crates.iorinfo
lib.rsrinfo
version0.2.5
sourcesrc
created_at2023-03-01 21:22:26.845881
updated_at2023-03-01 23:26:00.313473
descriptionGet basic information about your system from the command-line.
homepage
repositoryhttps://github.com/Sir-Bobert-II/rinfo
max_upload_size
id798332
size124,264
Decator (El-Wumbus)

documentation

README

RINFO

Get basic information about your system from the command-line. rinfo is a rust "rewrite" of qinfo. Unlike qinfo, rinfo is cross-platform (Linux, MacOS, and Windows are currently supported). rinfo is in beta, and it will stay there until the information collection methods have stabilized.

Usage

rinfo has configurable output. This can be achieved through command-line flags or with a configuration file. The default output looks similar to the following:

                   -`                     CPU: AMD Ryzen 5 5600X 6-Core Processor@4.38GHz (6 cores, 12 threads)
                  .o+`                    UPTIME: 1 day, 15 hours, 55 minutes and 230 ms
                 `ooo/                    RAM: 7.46 GiB/31.27 GiB (23.81 GiB available)
                `+oooo:                   BOARD: B550 GAMING X V2 (Gigabyte Technology Co., Ltd.)
               `+oooooo:                  LAN: 192.168.1.18 (IPV4)
               -+oooooo+:                 HOST: Basestation
             `/:-:++oooo+:                USER: decator
            `/++++/+++++++:               SHELL: zsh
           `/++++++++++++++:              OS: Arch Linux (linux)
          `/+++ooooooooooooo/`            
         ./ooosssso++osssssso+`           
        .oossssso-````/ossssss+`          
       -osssssso.      :ssssssso.         
      :osssssss/        osssso+++.        
     /ossssssss/        +ssssooo/-        
   `/ossssso+/:-        -:/+osssso+-      
  `+sso+:-`                 `.-/+oso:     
 `++:.                           `-/+\    
 .`                                 ` .   

Flags

rinfo 0.2.0
Get information about your system

USAGE:
    rinfo [FLAGS]

FLAGS:
    -h, --help                Prints help information
    -a, --omit-art            Don't print character art
    -p, --omit-caller         Don't print caller (USER, SHELL) information
    -c, --omit-cpu            Don't print CPU information
    -n, --omit-hostname       Don't print the system hostname
    -i, --omit-ip             Don't print local IP address
    -m, --omit-motherboard    Don't print motherboard information
    -o, --omit-os             Don't print operating system information
    -r, --omit-ram            Don't print RAM information
    -V, --version             Prints version information
    -v, --vertical-art        Print character art above information

Example

$ rinfo -api --omit-os
CPU: AMD Ryzen 5 5600X 6-Core Processor@2.06GHz (6 cores, 12 threads)
UPTIME: 5 days, 3 hours, 5 minutes, 1 second and 390 ms
RAM: 11.81 GiB/31.27 GiB (19.46 GiB available)
BOARD: B550 GAMING X V2 (Gigabyte Technology Co., Ltd.)
HOST: Basestation

Config File

Depending on your OS, the configuration file will be in a different location:

  • Linux - $XDG_CONFIG_HOME/SBII/rinfo.toml or $HOME/.config/SBII/rinfo.toml (e.g. /home/awesomeguy420/.config/SBII/rinfo.toml)
  • Windows - {FOLDERID_RoamingAppData}\SBII\rinfo.toml (e.g. C:\Users\CoolGuy69\AppData\Roaming\SBII\rinfo.toml)
  • MacOS - $HOME/Library/Application Support (e.g. /Users/Worstbuy/Library/Application Support)

The configuration file uses the TOML format, an example of one is seen below.

omitCpu = false
omitRam = false
omitMotherboard = true
omitCaller = false
omitHostname = false
omitOs = false
omitArt = false
omitIp = false
verticalArt = true

By default, any flags passed to the program will take precedence over the configuration. This meaning, with the above configuration, the output of rinfo --omit-art won't contain the art despite the configuration file specifying otherwise.

Installing

When there's a fuller release of rinfo, there will a Windows installer.

Releases

You can pick the latest release from the GitHub Releases. Windows doesn't have a compiled release because it's not stablized and isn't feature-ready. You'll need to compile on windows.

Manual compilation

Linux & MacOS

Arch Linux does have differing instructions, skip there if needed.

  1. Clone the repository

    git clone https://github.com/Sir-Bobert-II/rinfo
    
  2. Build

    cd rinfo
    cargo build --release
    
  3. Install

    install -Dvm755 target/release/rinfo /usr/bin/rinfo
    
Arch Linux
  1. Download the PKGBUILD

    curl -LO https://github.com/Sir-Bobert-II/rinfo/raw/master/packages/PKGBUILD
    
  2. Build and install

    makepkg -si
    
Commit count: 85

cargo fmt