Getting started with Scanyp Server For Linux/Mac

Getting Started with Scanyp on Windows

  • Start Scanyp Server.
    >./startserver.sh 
    
    The Scanyp Server will start and by default it's listening on the port 3500



    The listening port could be changed even from the command line
    >./startserver.sh  --Port 4000
    
    Or from the config.ini file.

    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.
  • Launch the analysis

    From another machine you can launch the analysis of your codebase
    >./analyze.sh  /home/mywork/myproject.json --identifier MyProject
    
    The --identifier switch is mandatory to define the project key, ScanypAnalyzer 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 Analyzer for the analysis.
    You can define the Scanyx server IP and port from the config.ini file or from the command line
    >./analyze.sh  /home/mywork/myproject.json --identifier MyProject --serverIP 192.34.23.45  --port 4000 
    
    After the analysis is done, the result could be accessed from the browser:



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



    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.
    >./analyze.sh  /home/mywork/myproject.json --identifier MyProject --perspective branch1
    
    And from the dashboard you can switch between perspectives of the same project.

    You can refer to the ScanypAnalyzer documentation to explore all the command line options. And to configure your custom rules, quality gates and trends, you can refer to the scanyx server admin doc.
    To get more details about the analysis per language:

Scanyp offers a wide range of features. It is often described as a Swiss Army Knife for developers.

Start Free Trial