system-report

Generate a comprehensive inventory of a Fedora Linux system in Markdown format.

system-report collects information about the system, hardware, storage, software, and network configuration and creates a timestamped set of Markdown reports that can be viewed with any Markdown viewer or editor.

The reports are intended to provide a convenient snapshot of the current system configuration and can be useful for documentation, troubleshooting, system administration, and comparison of system states over time.

Features

system-report generates the following reports:

• System

  • Fedora version
  • Kernel
  • Architecture
  • Desktop environment
  • KDE Plasma version
  • Display manager
  • Session type
  • Uptime and boot time

• Hardware

  • CPU
  • Memory
  • Motherboard and firmware
  • GPU

• Storage

  • Block devices
  • Partitions
  • Mounted filesystems and filesystem usage
  • SMART health
  • Btrfs filesystems
  • Btrfs subvolumes and snapshots

• Software

  • Installed software packages
  • Flatpak applications

• Network

  • Network interfaces
  • Interface type and state
  • MAC addresses
  • IPv4 and IPv6 addresses
  • Network speed
  • Default gateway
  • DNS servers

A Report Overview is generated for each report and provides links to all individual reports.

Example

A report set is stored in a timestamped directory:

reports/
└── 2026-08-19_17-06-03/
    ├── Report-Overview.md
    ├── system.md
    ├── hardware.md
    ├── storage.md
    ├── software.md
    └── network.md

The reports are ordinary Markdown files and do not require a special application to view them.

For example, the overview can be opened in Obsidian:

(This screenshot was created from Obsidian configured to use the Obsidian Nord theme)

Automatic Reports

system-report can optionally install a user-level systemd timer to generate reports automatically at a configurable interval.

The first report is generated immediately when automatic reporting is enabled. Subsequent reports are generated automatically according to the configured interval.

Automatic execution requires passwordless sudo, because some hardware and filesystem information can only be obtained with elevated privileges.

Requirements

system-report has been developed and tested on:

• Fedora Linux 44
• KDE Plasma 6.7
• Wayland

Other Linux distributions running KDE Plasma 6.x may also work but have not been tested.

Installation

See INSTALL.md for installation and configuration instructions.

system-report keeps its files within the project directory. The only files created outside it are the optional user-level systemd service and timer files.

Reports and Backup

Generated reports are stored separately from the project source and are intended to provide historical snapshots of the system configuration.

The reports/ directory is excluded from Git by default.

License

system-report is licensed under the MIT License.

See LICENSE for the full license text.

Changelog

See CHANGELOG.md for the project history and notable changes.