Links

RapidFort Command Line Interface Tools

The RapidFort command line interface (CLI) tools enable you to interact with RapidFort services. Stub and harden your Docker images, download reports, and more.

Installation

Minimum Requirements

Client System

  • 64-bit Intel-based Linux or Mac OS X client system
    • At least 2 GB of memory
      • You may need more memory when working with larger Docker images.
    • At least 10 GB of free space
      • You may need more free space when working with larger Docker images.
      • In general, please expect to have at least (4 * image size) free space available when generating stub images and (2 * image size) free space available when scanning images.
Please note that you must have a 64-bit Intel-based client system to use the RapidFort CLI tools. If your client system architecture is not supported, you may submit a feature request to RapidFort Support ([email protected]).

Applications

  • Bash
  • Python 3.7+ and pip3
    • RapidFort recommends Python 3.8.10 or higher
  • Docker
    • The RapidFort CLI tools must have permission to access the Docker daemon socket. Please verify that the user for whom the RapidFort CLI tools will be installed has permissions to access the Docker daemon socket.
      • For example, run the following commands:
        • docker images
        • docker pull <image>
      • For more information on managing Docker as a non-root user, please refer to Manage Docker as a non-root user.
      • If you are not able to give a non-root user permissions to access the Docker daemon socket, please install the RapidFort CLI tools as the root user.

RapidFort SaaS

Run the following command to install the CLI tools:
curl https://frontrow.rapidfort.com/cli/ | bash

RapidFort On-Premises

You will need the IP address or hostname of your RapidFort On-Premises deployment.
Run the following command to install the CLI tools:
curl https://<rapidfort_host>/cli/ | bash

Troubleshooting

Moved Permanently

bash: line 1: html: No such file or directory
bash: line 2: syntax error near unexpected token <'
'ash: line 2:301 Moved Permanently
Make sure that there is a / character following cli. For example:
curl https://frontrow.rapidfort.com/cli/ | bash
curl https://rapidfort.example.com/cli/ | bash

RapidFort CLI Tools

For more information on a command, run the command with --help.
  • rflogin: Log into RapidFort
  • rfstub: Generate a stub image
  • rfharden: Generate a hardened image
  • rfscan: Scan one or more images or container registries for packages and vulnerabilities
  • rfls: List RapidFort stub and hardened images that are available on the client system
  • rfjobs: List all RapidFort jobs for the current user (including jobs that are not available on the client system)
  • rfinfo: Show detailed information and optionally download reports for a RapidFort job