Skip to content

Getting started

Requirements

  • Python 3.10 or newer
  • psutil (installed with the library package)
  • Optional: distro (Linux), tldextract (PSL-aware domain redaction)

Platform tools such as nft, brew, or systemctl are used only when present. The tool never installs OS packages.

Install

Installs the core library and registers the sysinfo console script:

python3 -m pip install lupaxa-sysinfo-cli
sysinfo --version

Library only

For programmatic collection without a console script:

python3 -m pip install lupaxa-sysinfo

from lupaxa.sysinfo import collect_report

report = collect_report(cpu=True, memory=True)

From source (development)

Editable install of both workspace packages with dev extras:

make init
make install-dev
sysinfo --version

The library import path is lupaxa.sysinfo. The CLI module is lupaxa.sysinfo_cli (python -m lupaxa.sysinfo_cli).

First run

Default: basic info to stdout as pretty JSON:

sysinfo

CI-friendly collection (common sections, no spinner, strict missing):

sysinfo --profile ci --json ci-sysinfo.json

YAML or XML output can be printed or saved directly:

sysinfo --all --output yaml
sysinfo --all --yaml sysinfo.yaml
sysinfo --all --output xml
sysinfo --profile support --xml sysinfo.xml

Environment variables are excluded from --all and every profile. Enable them explicitly with --env only when they are needed.

Makefile helpers

make init         # clone makefile-skills into .makefiles/
make install-dev  # editable install with [dev]
make check        # lint + type + test (via makefile-skills)