Installation & Setup

Installation

Cloudsploit can be installed via npm, Docker, or built from source. Choose the method that best fits your workflow.

Prerequisites

  • Node.js: Version 14+ (for npm installation)
  • Docker: Version 20.10+ (for Docker installation)
  • Git: For cloning the repository
  • Cloud Credentials: AWS access key, Azure service principal, or GCP service account

Install via NPM

The simplest way to install Cloudsploit is using npm. This installs the CLI globally:

bash
1npm install -g @aquasecurity/cloudsploit

Verify the installation:

bash
1cloudsploit --version

Install via Docker

Pull the official Docker image from Aqua Security:

bash
1docker pull aquasec/cloudsploit:latest

Run a basic scan using Docker:

bash
1docker run --rm -v ~/.cloudsploit:/root/.cloudsploit \
2  -e AWS_ACCESS_KEY_ID=your_key \
3  -e AWS_SECRET_ACCESS_KEY=your_secret \
4  aquasec/cloudsploit scan aws

Info

The -v ~/.cloudsploit:/root/.cloudsploit mount persists configuration between runs.

Install from Source

For development or the latest features, clone and build from source:

bash
1git clone https://github.com/aquasecurity/cloudsploit.git
2cd cloudsploit
3npm install
4npm run build
5npm link

Post-Installation Setup

After installing, you need to configure cloud provider credentials:

  1. 1
    Create API credentials

    Generate an access key for AWS, a service principal for Azure, or a service account key for GCP with read-only permissions initially.

  2. 2
    Configure credentials

    Set credentials via environment variables, AWS profile, or Cloudsploit config file (~/.cloudsploit/config.json).

  3. 3
    Test connection

    Run a quick scan with --list flag to verify resource discovery works.

Next: Configuration