purr(1)

NAME
purr - Fast, featureful, cross-platform fetching tool written in Rust

SYNOPSIS
purr [--verbose] [-c|--config] [--no-config] [--all] [-n|--neofetch] [--json] [--ascii_distro] [--ascii_colors] [--no_ascii_bold] [-L|--logo] [--off] [--backend] [--source] [--separator] [--no_bold] [--underline_char] [--title_fqdn] [--colors] [--stdout] [--memory_unit] [--uptime_shorthand] [--cpu_cores] [-h|--help] [-V|--version] [subcommands]

DESCRIPTION
Fast, featureful, cross-platform fetching tool written in Rust

purr is a fast, neofetch-compatible system information tool. With no arguments it prints a neofetch-style report — the same fields, styling, and ${c1}..${c6} ASCII logo format — then exits. Probes run in parallel, so a typical run completes in a few milliseconds.

Output is controlled by a TOML configuration file and the options below; precedence is defaults, then the config file, then command-line flags. Use --json for machine-readable output.

OPTIONS

--verbose
    Include verbose output or not

-c, --config <CONFIG>
    Path to a custom config file

--no-config
    Ignore any config file and start from the built-in defaults

--all
    Use the all-probes preset

-n, --neofetch
    Use the neofetch text renderer

--json
    Emit JSON instead of text

--ascii_distro <DISTRO>
    Force a specific distro logo (e.g. "arch")

--ascii_colors <LIST>
    Override logo colours (space/comma list, e.g. "4 6 1")

--no_ascii_bold
    Don't bold the logo

-L, --logo
    Show only the logo (no info)

--off
    Hide the logo

--backend <BACKEND>
    Logo backend: ascii or kitty

--source <PATH>
    Image source (PNG) for the kitty backend

--separator <STR>
    Separator between labels and values

--no_bold
    Don't bold the title and labels

--underline_char <CHAR>
    Character used for the title underline

--title_fqdn
    Show the fully-qualified hostname

--colors <LIST>
    Override text colours (space/comma list)

--stdout
    Pipe-friendly output: disable colour

--memory_unit <UNIT>
    Memory unit: kib, mib, or gib

--uptime_shorthand <MODE>
    Uptime format: on, tiny, or off

--cpu_cores <MODE>
    CPU cores: logical, physical, or off

-h, --help
    Print help

-V, --version
    Print version

SUBCOMMANDS

purr-generate(1)
    Generate a new config file

purr-config-path(1)
    Return default config file path

purr-help(1)
    Print this message or the help of the given subcommand(s)

EXAMPLES

purr
    Print the default neofetch-style report.

purr --all
    Show every available probe.

purr --json
    Emit the probe results as JSON for scripting.

purr -L
    Print only the logo, with no system information.

purr --ascii_distro arch --ascii_colors "4 6 1"
    Force the Arch logo and recolour it.

purr generate --neofetch
    Write a starter neofetch-style config file.

ENVIRONMENT

NO_COLOR
    When set to a non-empty value, disables all colour output (https://no-color.org). The --stdout flag sets this automatically.

RUST_LOG
    Controls log verbosity, e.g. RUST_LOG=debug. Passing --verbose raises the level to trace.

FILES

config.toml
    Configuration file, read from the platform configuration directory (precedence: defaults < config file < CLI flags). Run purr config-path to print its resolved path, or purr generate to write a starter file.

VERSION
v1.0.0

AUTHORS
justin13888 <20733699+justin13888@users.noreply.github.com>