Install CodeScene on Windows

This guide walks you through the steps to install and configure CodeScene on your Windows environment. Follow the instructions below to get up and running quickly.

New free trial flow | Windows installation guide (Clone)

Installation requirements

  • Supported versions: Windows 10 or 11 (with all updates installed)
  • Administrative rights for script execution. Otherwise, consult an administrator for installation assistance.
  • Docker must be installed and running
  • Firewall: Make sure port 3003 is open if a firewall is active
  • VPN: Disable any active VPN connections during installation
  • You will encounter several dialog prompts while running this installation script, which may require your input. Ignoring them will result in an unsuccessful installation.

Can’t use Docker? Use JAR file (with limited functionality)

Installation

  1. Run the installation script in Powershell:
    [System.Text.Encoding]::UTF8.GetString( (Invoke-webrequest -URI "https://downloads.codescene.io/enterprise/install/windows/install.ps1").Content) | iex
  2. Script will run through a few checks to ensure that Docker is installed and running, and that port 3003 is available.
  3. Provide a local path to your Git clones, or skip this step if you plan to analyze remote repositories.
  4. The script will attempt to open CodeScene in your default web browser. If we're unable to open your browser automatically, you can access CodeScene manually at localhost:3003 or, if you're on a headless system, you may need to use your server name.
  5. Else, you can access CodeScene manually at localhost:3003, or you may need to use your server name if you're on a headless system.

Next steps

Frequently asked questions

Can't find the answer here? Contact our support team.

Where can I see full deployment requirements and instructions?

What steps will the installation script cover?

  • After you enter the provided command into your Terminal (Mac or Linux) or PowerShell (Windows), the script will run through a few checks to make sure that Docker is installed and running and that port 3003 is available.
  • You will be asked to provide a local path to your Git clones. You may skip this step if you plan to analyze remote repositories, which is the most common choice.
  • The script will attempt to open CodeScene in your default web browser. If we're unable to open your browser automatically, you can access CodeScene manually at localhost:3003 or if you're on a headless system, you may need to use your server name.

Do I have to create a Docker container?

No, this installation script will download the latest image and create a container that will automatically start. 

When should I provide a local path to my repositories?

Once you install CodeScene and are ready to analyze your first project, CodeScene will ask which repositories you want to analyze and where they are located. You can either analyze remote repositories hosted on platforms like GitHub, GitLab, Bitbucket, Azure and your private Git or you may analyze local Git clones.

Where can I access CodeScene after installation?

After CodeScene is installed successfully, you may access it manually at port 3003 or if you're on a headless system, you may need to use your server name.

Where can I start or stop CodeScene from running?

Once CodeScene is installed, you can start or stop it from running via the Docker dashboard.

I am experiencing an unexpected issue or application behavior. What can I do?

If you’re facing an unexpected issue or application behavior, you can use detailed analysis diagnostics and logs to gather more data or reach out to CodeScene Support.

Do I have to pay to use CodeScene?

CodeScene is free for open-source projects. We also have a set of paid plans so that you can tailor CodeScene to your needs or analyze private repositories. This allows larger organizations to benefit from advanced analyses like CodeScene's cost metrics and delivery performance measures. We have a free trial so you can evaluate CodeScene before starting a plan.