Sysreport is a command-line tool, so make sure you can log in to the target system using Secure Shell (SSH) or have a local console and are comfortable working on the Linux command line.

Confirm Python and Git are installed

To confirm Python is installed, run the following command:

    

        
        
            python --version
        
    

If Python is installed, a version number will be displayed:

    

        
        Python 3.9.5

        
    

If Python is not installed, use the package manager for your Linux distribution to install it.

To confirm Git is installed, run the following command:

    

        
        
            git --version
        
    

If Git is installed, a version number will be displayed:

    

        
        git version 2.34.1

        
    

If Git is not installed, use the package manager for your Linux distribution to install it.

Install Sysreport

You can download Sysreport by cloning the GitHub repository:

    

        
        
            git clone https://github.com/ArmDeveloperEcosystem/sysreport.git
        
    

Test Sysreport

Confirm Sysreport works correctly by changing into the sysreport/src directory and running the command:

    

        
        
            cd sysreport/src
python sysreport.py --help
        
    

If Sysreport is working correctly, the usage message is displayed:

    

        
        usage: sysreport.py [-h] [--config] [--advice] [--no-advice] [--color]
                    [--no-color] [--vulnerabilities] [-v]

Check system configuration

optional arguments:
  -h, --help         show this help message and exit
  --config           list kernel build-time configuration
  --advice           show configuration advice
  --no-advice        don't show configuration advice
  --color            use ANSI color escape codes in output
  --no-color         disable ANSI color escape codes in output
  --vulnerabilities
  -v, --verbose      increase verbosity

        
    
Back
Next