Skip to content

Deploy Model Scanner CLI

Before deploying Model Scanner, make sure you understand:

Select OS

Select your operating system to view installation instructions.

Select Deployment Type

Select Hybrid or Disconnected mode. See Hybrid and Disconnected modes for more information.

  1. Export your HiddenLayer information (product license, API key, and API secret). For Hybrid mode, scan results are sent to the HiddenLayer Console.

    • Replace %QUAY_USERNAME% and %QUAY_PASSWORD% with actual values.
    • Replace %CLI_LICENSE% with the Model Scanner CLI license key.
    • Replace %HL_API_KEY and %HL_API_SECRET% with your HiddenLayer API key and secret, generated in the Console.
    export HIDDENLAYER_USERNAME=%QUAY_USERNAME%
    export HIDDENLAYER_PASSWORD=%QUAY_PASSWORD%
    export HL_LICENSE=%CLI_LICENSE%
    export HL_CLIENT_ID=%HL_API_KEY%
    export HL_CLIENT_SECRET=%HL_API_SECRET%
  1. Run the following commands to login to the HiddenLayer Quay repository.

    docker login --username=$HIDDENLAYER_USERNAME --password=$HIDDENLAYER_PASSWORD quay.io
  2. Use the docker pull command to download the Model Scanner CLI image.

    • Change the Model Scanner CLI version if you want to pull a different Model Scanner version. For example, change latest to 25.1.0.
    docker pull quay.io/hiddenlayer/distro-cli-modelscanner:latest
Model Scanner is Ready to Scan Model Files

The Model Scanner Enterprise CLI is ready. See Scan Model Files for instructions on scanning model files.