LinuxCommandLibrary

sfdk-check

Check Salesforce DX project configuration

TLDR

Display test suites

$ sfdk check --list-suites
copy

Run all or essential test suites
$ sfdk check
copy

Add testing level to the check
$ sfdk check [[-l|--levels]] +[level]
copy

Remove testing level from the check
$ sfdk check [[-l|--levels]] -[level]
copy

Add testing suite to the check
$ sfdk check [[-s|--suites]] +[suite]
copy

Remove testing suite from the check
$ sfdk check [[-s|--suites]] -[suite]
copy

SYNOPSIS

sfdk-check

DESCRIPTION

The `sfdk-check` command is a utility primarily used within the Software Foundation Development Kit (SFDK) environment. Its primary function is to perform a suite of sanity checks to verify the integrity and consistency of the SFDK installation and its configuration. These checks might include validating file permissions, verifying the existence of required directories and files, testing network connectivity to essential services, ensuring proper environment variable settings, and assessing the overall health of the SFDK environment. The specific checks performed by `sfdk-check` are highly dependent on the particular SFDK implementation and the tools it relies upon.

Administrators and developers utilize `sfdk-check` to proactively identify potential problems within the SFDK setup. This allows for early detection and resolution of issues, ensuring a stable and reliable development environment. Because it flags common misconfiguration, this tool avoids problems when building and deploying software with the SDK.

It's important to note that `sfdk-check` is not a standard Linux command and is specific to SFDK environments.

CAVEATS

`sfdk-check` is highly specific to the SFDK environment where it's installed. Its functionality and output will vary significantly depending on the particular SFDK implementation. Requires appropriate SFDK environment to run.

USAGE NOTES

Because this tool is SFDK specific, it is usually run automatically after installing or updating the Software Foundation Development Kit. The exact procedure is specific to that development kit.

Copied to clipboard