DeepScan Enterprise Getting Started

Are you trying to use DeepScan? If so, see Contact us for your question or trial.

This document leads you through some of the basics of using DeepScan Enterprise. It contains the following parts:

What is DeepScan Enterprise?

DeepScan Enterprise is a suite of packages that provides a way for you to use DeepScan on your own environment.

For example, you can host your own DeepScan.io, and analyze code in your local folder, and manage the issues in your SonarQube. When you use DeepScan Enterprise, you can manage your JavaScript projects on your GitHub Enterprise or GitLab behind the firewall instead of GitHub.com.

Why use DeepScan Enterprise?

When you have a large-scale JavaScript code base, managing its quality is often complex. You should deal with the code quality from coding to deploy. DeepScan, engineered to support a full-fledged JavaScript analysis, helps you to manage your JavaScript more reliably through the full development cycle.

Packages

DeepScan Enterprise provides the packages to be integrated seamlessly with your workflow. The packages are:

On-premise

DeepScan On-premise is the core application that powers our hosted DeepScan installations (DeepScan.io). This covers everything related to getting it running on your own infrastructure and local network. All data including source code is stored on machines that you control.

It includes the same great features as DeepScan.io.

Installation

DeepScan provides Docker images allowing you to easily install DeepScan On-premise on your instance.

To get the images for your trial, you must contact DeepScan.

Guide

The following guides are available:

Guide Description
Administrator Guides In-depth guides for organizational administrators who are deploying, configuring, and managing a DeepScan instance.
User Guides Documentation for organizational developers and project managers to learn everything about DeepScan.

Editor plugins

DeepScan Enterprise provides the tools to integrate into the development workflow.

With our editor plugins, you can inspect your code directly in the code editor.

Installation

DeepScan provides plugins for Eclipse, IntelliJ, and Visual Studio Code.

To get the plugins for your trial, you must contact DeepScan.

Guide

The following guides are available:

Guide Description
Eclipse Plugin An Eclipse plugin which enables you to run DeepScan on the fly in your Eclipse.
IntelliJ Plugin An IntelliJ plugin which enables you to run DeepScan on the fly in your IntelliJ IDEA and WebStorm.
Visual Studio Code Extension A Visual Studio Code Extension and its language server. Unlike the open source version working with the DeepScan server, you can run DeepScan standalone in the extension.

SonarQube plugin

DeepScan Enterprise provides the tools to integrate into the quality management workflow.

With our SonarQube plugin, you can inspect JavaScript more in depth in your SonarQube.

Installation

To get the SonarQube plugin for your trial, you must contact DeepScan.

Guide

The following guides are available:

Guide Description
SonarQube Plugin A SonarQube plugin which enables you to inspect JavaScript and TypeScript using DeepScan in your SonarQube platform.

Node.js package

DeepScan Enterprise provides the tools to integrate into the development and build process.

With our Node.js package, you can inspect your project in the command line on your machine such as a CI server.

Installation

To get the package for your trial, you must contact DeepScan.

Guide

The following guides are available:

Guide Description
Node.js Package A Node.js package which enables you to run DeepScan in the command line or programmatically.