Getting Started with Scanyp on Windows, Linux/MacOS

To explore the Scanyp product capabilities you need to achieve two basic steps:

Step1: Start the scanyp server

Open a terminal, go to the folder where the scanyp server is installed and execute this command:

The Scanyp Server will start and by default it's listening on the port 3500
scanyp server running

The listening port can be changed even from the command line

>scanypserver.exe  --Port 4000
>./scanypserver  --port 4000

Or from the config.ini file by changing the port variable:
Port = 4000
The database storing the analysis result is by default stored in the Scanyp install directory. It's recommended to change this path from the config.ini file to avoid overriding it after a new install.

Step2: Launch the analysis

From the machine server or another machine you can launch the analysis of your codebase

>scanyp.exe  --input C:\work\MySolution.sln --identifier MyProject
>./scanyp --input /home/mywork/myjavaproject --identifier MyProject

The --identifier switch is mandatory to define the project key, the scanyp agent will get from the scanyp server the configuration of this specific key if it's found, else a default configuration will be created in the server and it will be used by the scanyp agent for the analysis. You can define the scanyp server IP and port from the config.ini file or from the command line

>scanyp.exe  --input C:\work\MySolution.sln --identifier MyProject --serverIP  --port 4000
>./scanyp  /home/mywork/myjavaproject --identifier MyProject --serverIP  --port 4000

After the analysis is done, the result could be accessed from the browser at http://serverip:serverport, by default the url is
Login: test

scanyp projects list
To get the analysis details of a project you can just click on its link:
scanyp dashboard

If you need multiple analysis views of the same project, where each analysis has its own coding rules. Or you need a view per branch you can use the perspective feature.

>scanyp.exe  --input  C:\work\MyDotNEtSolution.sln --identifier MyProject --perspective branch1

You can refer to the scanyp agent documentation to explore all the command line options. And to configure your custom rules, quality gates,metrics, labels and charts, you can refer to the scanyp server admin documentation. And to get more details about the analysis per language:

>./scanyp  /home/mywork/myjavaproject --identifier MyProject --perspective branch1