Chapter 2. Getting Started With the Squore CLI

Table of Contents

Installation Prerequisites
Supported Operating Systems
For All Systems
Packages for Windows
Packages for Linux
Packages for CentOS and Red Hat Enterprise Linux
Packages for Ubuntu
Deploying Squore CLI
On Windows
On Linux
Third-Party Plugins and Applications
Post Installation Actions
Upgrading Squore CLI
Removing Squore CLI
On Windows
On Linux
Saving Credentials to Disk
Running The Sample Scripts
Squore in a Continuous Integration Environment

Squore CLI is a package that is installed on every client computer that needs to perform local code analyses or trigger a remote analysis on Squore Server. It contains the client (squore-engine.jar), its libraries, configuration files and some sample job files to help you get started. In this section, you will learn more about the different setup configurations supported by the CLI, its installation and integration into a Continuous Integration environment.

Squore CLI accepts commands and parameters to communicate with Squore Server. Inside the installation folder, some scripts are provided as examples to create projects, save encrypted credentials to disk, and synchronise the client's configuration with the server.

There are two ways to contemplate the deployment of Squore CLI:

  1. As a way to analyse code and process data on a client machine and send the results to the server.

  2. As a way to instruct the server to carry out an analysis of code and other input data.

Note

Squore CLI and Squore Server must always be the same version in order to work together.