SAMPLE PROJECT OUTLINE — EDIT ME: Add the scripts and results you have actually built before presenting this as a finished tool.
Goal
Collect small, read-only helpers for documenting Linux lab environments consistently. The project should explain what each check reports and avoid changing the host during inventory.
Suggested modules
- Host and kernel summary.
- User, group, and service inventory.
- File capability and permission review.
- A Markdown report that records command output with timestamps.
Design notes
Keep each check independent so a user can run only the section they need. Make errors visible, label commands that require elevated access, and avoid copying secrets from environment variables or configuration files into generated reports.
To complete
Add the actual source files, example output from a disposable lab machine, supported distributions, and a short usage guide. Link the repository or release after the project is ready.