Just 3 steps to enjoy Sider Scan!

We will show you how to run Sider Scan and analyze the sample repositories prepared by Sider. Believe us! It is much easier than you think.

Step 1: Git clone the sample repository

First, please clone the sample repository we prepared for you as shown below. This repository contains problematic source code. Can you find which code has the problem by manual?

$ git clone https://github.com/sider-bughunter/hello_sider.git

Step 2: Run Sider Scan

Run Sider Scan as follows. No installation is required. The latest Sider Scan docker image is automatically downloaded from the Docker Hub and analysis begins.

Note: If you moved to the directory hello_sider after executing Step 1 git command, remove /hello_sider from the command argument, instead, use -v "$(pwd)":/builds

$ docker run -v "$(pwd)/hello_sider":/builds -w /builds --rm sider/sider_scan_runner:latest sider run /builds
[2022-05-18T07:52:33.774] [INFO] default - SiderScanRunner is running.
[2022-05-18T07:52:33.777] [INFO] default - the radump file to import does not exist. path: /builds/output.radump
[2022-05-18T07:52:33.777] [INFO] default - scanning /builds
[2022-05-18T07:52:58.546] [INFO] default - exported the project to /builds/output.radump
[2022-05-18T07:52:58.552] [INFO] default - Server URL was not supplied. Generating detail viewer link was skipped.
[2022-05-18T07:52:58.564] [INFO] default - 2 block(s) was detected.
[2022-05-18T07:52:58.638] [INFO] default - All actions were successfully finished.
[2022-05-18T07:52:58.643] [WARN] default - Contact email address is not specified. Please set `enableSiderScanTracing.userEmail` on your configration file (e.g.: .siderscan.json).

Step 3: View analysis results in a web browser

The Sider Scan console message, “2 block(s) was detected.“, means that 2 problems were detected.

The report files are generated in the following folder. The file name is “report-<Executed Date>-<Identification Number>.html”.

$ ls hello_sider/reports/
2022-05-18_07-52-42-1-1-cpd.png   report-2022-05-18_07-52-42-1-1-cpd.html  report-2022-05-18_07-52-42-1-1-ss-0.html
2022-05-18_07-52-42-1-1-ss-0.png  report-2022-05-18_07-52-42-1-1-cpd.txt   report-2022-05-18_07-52-42-1-1-ss-0.txt

Open the HTML report file in your browser, either from the GUI shell with a mouse click, or from the command such as browse, xdg-open, or open. It depends on your operating system.

$ browse hello_sider/reports/report-2022-05-18_06-28-44-2-2-ss-0.html

Now, do you find any interesting analysis results?