This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

host-check

Use the host check command to verify if your system is appropriately setup to perform a scan.

The command endorctl host-check allows you to quickly verify if your system is setup with the appropriate tools to perform a successful scan.

Usage

To verify that your local host is appropriately configured to scan a given repository:

  1. Clone the repository you’d like to verify system setup for. The following instructions should be updated to the repository of your selection.

     ```shell
     git clone https://github.com/endorlabs/app-java-demo.git
     ```
    
  2. Navigate to the root of the repository you’ve cloned:

     ```shell
     cd ./app-java-demo
     ```
    
  3. Run the host check command:

     ```shell
     endorctl host-check
     ```
    

To verify that your local host is appropriately configured with AI recommendations on how to address any issues perform the following procedure and add the --droid-gpt flag to the host check command:

    ```shell
    endorctl host-check --droid-gpt
    ```

Options

The endorctl host-check command uses the following flags and environment variables:

Flag Environment Variable Description
auth-check-only ENDOR_HOST_CHECK_AUTH_CHECK_ONLY Validate authentication credentials only.
droid-gpt ENDOR_HOST_CHECK_DROID_GPT Use DroidGPT to generate remediation advice.
path ENDOR_HOST_CHECK_PATH Set the path to the repository to scan on the local filesystem. Example: --path=/Users/endorlabs/github/myrepo.