Quick Start by Deployment¶

Choose the guide that matches where PostQ will run or where completed reports will be reviewed. Every scanning deployment uses the same scanner-service behavior and deterministic report contracts.

Native CLI

Install Java and OpenGrep directly for local commands, scripts, or managed agents.

Start with the CLI

VS Code

Give developers workspace scans, Problems diagnostics, report history, and source navigation.

Start in VS Code

Eclipse

Add project scans, report review, problem markers, and source navigation to Eclipse or Spring Tools.

Start in Eclipse

Container

Run a hardened, non-interactive Linux image with Java and OpenGrep included.

Start with a container

CI/CD

Add a version-pinned native or container scan and retain protected pipeline reports.

Start in CI/CD

Report Viewer

Open completed report folders without scanner execution, Java, OpenGrep, or activation.

Start with the viewer

Choose by operating model¶

Your goal	Recommended guide
Evaluate one repository from a workstation	Native CLI
Put scanning directly in a developer's editor	VS Code or Eclipse
Standardize runtime dependencies or support air-gapped transfer	Container
Scan immutable checkouts automatically	CI/CD
Give reviewers access without scanner execution	Report Viewer

Scanning versus review-only deployment¶

The CLI, VS Code, Eclipse, container, and CI/CD paths run scanner-service. They require a valid offline trial license in the distributed beta. The Report Viewer is read-only and does not require a scanner license.

Each scanning guide follows the same outcome sequence:

Choose a deployment and identify its requirements.
Install host prerequisites from trusted publisher resources.
Run the pre-install check and install the matching PostQ artifact.
Activate the offline license.
Scan the downloadable Java sample or a representative repository.
Confirm the report set and begin review.

Official installation resources¶

Use your organization's approved software distribution process where one exists. These publisher links are included here so you can complete a first scan without searching for prerequisite installers.

Prerequisite	Official installation resource	Used by
Java	Eclipse Temurin installation	CLI, IDE integrations, native CI/CD
OpenGrep	OpenGrep installation	CLI, IDE integrations, native CI/CD
Visual Studio Code	Visual Studio Code download	VS Code extension
Eclipse	Eclipse downloads	Eclipse plugin
Spring Tools	Spring Tools	Spring Tools-based Eclipse environments
Docker Engine	Install Docker Engine	Containers and container CI/CD
Podman	Podman installation	Containers and container CI/CD

For supported versions, platform notes, and validation commands, see Prerequisites and the complete official installation resources.

Download a project for the first scan¶

Download the PostQ Java Quick Start project

The ZIP contains a dependency-free Java showcase with RSA key generation, AES-GCM encryption and decryption, RSA signing and verification, cross-function parameter flow, intentional hardcoded anti-patterns, and provider-dependent post-quantum examples. You do not need to compile it before scanning. Extract the ZIP and select its postq-java-quickstart directory as the project source in the deployment guide you chose above.