Skip to content

Getting Started

Requirements

  • Python 3.10 or newer
  • psutil (installed with the 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

python3 -m pip install lupaxa-sysinfo
sysinfo --help

Library import:

from lupaxa.sysinfo import collect_report

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

Module entry point:

python -m lupaxa.sysinfo --profile ci --json out.json

From Source (Development)

Editable install with dev extras:

make init
make python-install-dev
sysinfo --version

The import path is lupaxa.sysinfo (python -m lupaxa.sysinfo for the 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 python-install-dev   # editable install with [dev]
make python-check         # lint + type + test (via makefile-skills)