vip validate preflight

Run a full suite of validation tests against a local Node.js codebase to identify potential issues that could prevent successful building or deploying.

Usage

vip validate preflight [options]

Options

Option	Description
-d, --debug	Generate verbose output during command execution to help identify or fix errors or bugs.
-h, --help	Retrieve a description, examples, and available options for a (sub)command.
-n, --node-version	Set a version of Node.js for the tests. Accepts semver format (MAJOR.MINOR.PATCH) or a MAJOR (18, 20, 22).
-P, --path	[value] Path to the app to be tested (defaults to “/home/runner/work/vip-cli/vip-cli”)
-p, --port	Set a port for the application. (Defaults to a random value between 3001 and 3999)
-V, --verbose	Increase logging level to include app build and server boot up messages. (disabled by default)
-v, --version	Retrieve the version number of VIP-CLI currently installed on the local machine.
-w, --wait	Set the number of milliseconds to delay the start of the tests. Only necessary if an application requires a greater amount of time to start. (defaults to 3000)

Examples

- Run the validate command from within the root of the local Node.js codebase directory.
$ vip validate preflight

- Run the validate command against a Node.js application directory at a specific local path.
$ vip validate preflight --path=/Users/example/Desktop/example-node-repo

- Run the validation tests with a specific version of Node.js.
$ vip @example-node-app.production validate preflight --node-version=20

- Output the results of the validation tests to a local file in JSON format.
$ vip validate preflight --format=json > results.json

- Run the validation tests with settings based on a targeted VIP Platform environment.
$ vip @example-node-app.production validate preflight