Skip to content

Install PostQ Code Scanner

Install the PostQ interfaces your team needs and the prerequisites for the selected deployment. Use the release package that matches your operating system and product version.

Optional guided prerequisite installation

The prerequisite artifact includes an interactive helper. It displays numbered choices and either uses a dependable platform package manager or opens the tool's official installation guide.

.\postq-code-scanner-prereq-install.ps1

bash ./postq-code-scanner-prereq-install.sh

Re-run the prerequisite checker after using the helper. Opening a download page is not proof that a dependency is installed or available to the scan account. If PowerShell blocks the Windows checker, see PowerShell blocks the prerequisite checker. If OpenGrep download is blocked by Microsoft Edge, SmartScreen, or Windows Defender, see OpenGrep download is blocked by Microsoft Edge, SmartScreen, or Defender.

Install the native CLI

  1. Extract postq-code-scanner-cli-<version>.zip to an approved application directory.
  2. Keep the distribution's bin, lib, report-viewer, and legal files together.
  3. Add bin to PATH only if your organization permits it.
  4. Run the help command from Quick Start to confirm launcher access.

If OpenGrep is not on PATH, set POSTQ_OPENGREP_PATH or pass --opengrep-path for each scan. If Java is not on PATH, set POSTQ_JAVA_PATH or pass --java-path for each scan.

Install the VS Code extension

  1. Install a supported VS Code release.
  2. Open Extensions.
  3. Select the Extensions menu, then Install from VSIX....
  4. Select postq-code-scanner-vscode-<version>.vsix.
  5. Reload VS Code when prompted.
  6. Open the PostQ Code Scanner Activity Bar view.

On first scan or workspace selection, the extension checks Java, OpenGrep, and license readiness. If Java or OpenGrep is not available on the VS Code process PATH, select the executable file from the configuration prompt. Java must be valid before the extension attempts license validation.

Command-line installation is also available:

code --install-extension ./postq-code-scanner-vscode-<version>.vsix

Install the Eclipse plugin

In Eclipse or Spring Tools, open Help > Install New Software..., choose Add... > Archive..., select postq-code-scanner-eclipse-plugin-<version>.zip, select PostQ Code Scanner, and complete the installation. For managed dropins deployment, extract the ZIP and copy dropins/postq-code-scanner into the target Eclipse installation's dropins directory. Then open:

Window > Perspective > Open Perspective > Other > PostQ Code Scanner

Open the Configuration view or Window > Preferences > PostQ Code Scanner to select the offline license file, Java executable, and OpenGrep executable. Scan commands open the configuration path so you can correct missing Java, OpenGrep, or license settings before a scan starts.

Install the container image

Load the platform-specific OCI archive:

docker load --input postq-code-scanner-cli-oci-image-<version>.tar

podman load --input postq-code-scanner-cli-oci-image-<version>.tar

Use linux/amd64 for x86 hosts and linux/arm64 for ARM hosts. Docker Desktop and Podman machine run the Linux image through their Linux VM on Windows and macOS.

Install the Report Viewer

The report viewer is included in the CLI distribution under report-viewer/index.html. Copy that file into a generated report folder and open the copied index.html in a supported desktop browser. No service, Java runtime, OpenGrep installation, or scanner license is required to read existing reports.

Upgrade or replace an installation

  1. Retain report folders that must remain available for comparison or audit.
  2. Read the new artifact's notices and release documentation.
  3. Run its matching prerequisite checker.
  4. Install the new artifact in a versioned location or replace the IDE package through the host's normal extension process.
  5. Validate license status and complete one representative scan before broad rollout.

Do not merge lib directories or legal bundles from different product versions.