Skip to content

Install PostQ Code Scanner

PostQ distributions are self-contained release artifacts. Install only the interfaces needed by the target users; every scanning interface delegates to the same scanner-service behavior.

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.

Install the native CLI

  1. Extract postq-code-scanner-cli-<version>.zip to an approved application directory.
  2. Keep the distribution's bin, lib, 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 Crypto Readiness Activity Bar view.

Command-line installation is also available:

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

Install the Eclipse plugin

The current postq-code-scanner-eclipse-plugin-<version>.zip is an Eclipse PDE project package, not a p2 update site. Follow the README supplied inside the archive to import or install it in the approved Eclipse or Spring Tools environment. Then open:

Window > Perspective > Open Perspective > Other > PostQ Crypto Readiness

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

Extract postq-code-scanner-report-viewer-<version>.zip and open 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.