Getting Started

You can choose to install the pre-compiled application or build it from source.

Option 1: Quick Install (Recommended)

Download the latest compiled installer for your operating system directly from our website:

Install

Option 2: Build from Source

Prerequisites

To ensure all scanners, agents, and tools work correctly, your system must have the following dependencies installed:

Node.js (v18+ recommended) and npm/yarn
Semgrep (Required for static analysis features)
PHP (Required for PHP-specific analysis tools)
Python (Required for Python-specific tools and agent scripts)
Java (Required for Java deserialization and analysis tools)

Compilation Steps

Clone the repository:

git clone https://github.com/deflectra/deflectra.git
cd deflectra

Install Frontend dependencies and build:
```
cd Deflectra-UI
npm install
```
Install Backend/Desktop dependencies:
```
cd ../electron
npm install
```
Windows Build Requirements (Required for native modules):
- Install Visual Studio Build Tools.
- During installation, select the "Desktop development with C++" workload.
- Ensure the following two components are checked:
  - MSVC v143 - VS 2022 C++ x64/x86 build tools (or the latest version available).
  - Windows 11 SDK (or the version matching your OS).

⚠️ IMPORTANT: If you are using Visual Studio 2026 (version 18.x):

node-gyp may not yet recognize this version. You must manually patch electron/node_modules/node-gyp/lib/find-visualstudio.js with the following changes:
In findVisualStudio2019OrNewerFromSpecifiedLocation, findVisualStudio2019OrNewerUsingSetupModule, and findVisualStudio2019OrNewer, add 2026 to the array of supported years: [2019, 2022, 2026].
In getVersionInfo, add the mapping for version major 18:
if (ret.versionMajor === 18) {
  ret.versionYear = 2026
  return ret
}
In getToolset, add the mapping for year 2026:
} else if (versionYear === 2026) {
  return 'v145'
}

Build the Application: From the electron directory, you can build the production-ready application for your OS. This command will compile the Angular frontend interface, generate the local Prisma database schema, and package the Electron app using electron-builder:
```
npm run build
```

Option 3: Run in Development Mode

If you just want to run the application without building the executable, you can follow these steps:

Clone the repository:

git clone https://github.com/deflectra/deflectra.git
cd deflectra

Install Frontend dependencies:
```
cd Deflectra-UI
npm install
```

Build the Angular frontend interface:

ng build --configuration production --base-href ./ --output-path ../electron/dist

Install Backend/Desktop dependencies:
```
cd ../electron
npm install
```
Initialize the Database: If it's your first time running the app or you see "table does not exist" errors, run:
```
npx prisma db push --schema prisma_resources/schema.prisma
```
Start the application:
```
npm start
```

Getting Started​

Option 1: Quick Install (Recommended)​

Option 2: Build from Source​

Prerequisites​

Compilation Steps​

Option 3: Run in Development Mode​