CLI

The Fugue CLI is a command line client that allows you to interact with the Fugue API. You can create environments, trigger scans, get details for an environment, and more.

Usage

Fugue API Client

Usage:
  fugue [command]

Available Commands:
  create      Create a resource
  delete      Delete a resource
  get         Retrieve a resource
  help        Help about any command
  list        List a collection of resources
  scan        Trigger a scan
  sync        Sync files to your account
  update      Update a resource

Flags:
  -h, --help      help for fugue
      --version   version for fugue

Use "fugue [command] --help" for more information about a command.

Installation

Note

Currently only macOS builds are available.

  1. Download a prebuilt binary from the releases page on GitHub

  2. Place the fugue binary in your $PATH, for example in /usr/local/bin

  3. Change file permissions:

chmod 755 /usr/local/bin/fugue

4. Set environment variables FUGUE_API_ID and FUGUE_API_SECRET:

export FUGUE_API_ID=61ae1bed-1b6f-1234-5678-1a2b3c4d5e6f
export FUGUE_API_SECRET=f7a89ac99cab9dd2948712345678901234567890

Environment Variables

The client uses the following required environment variables:

Accepted Parameter Values

How to format fugue flags

For a list of accepted values, see:

Add quotation marks around each compliance family or resource name. You may specify multiple values:

  • "AWS.EC2.Vpc","AWS.SNS.Topic"

  • "CIS","GDPR","NIST"

How to look up fugue arguments

Tips

env alias

You can use the alias env instead of environment throughout the CLI. For example, this command:

fugue create aws env [flags]

is the same as this command:

fugue create aws environment [flags]

Help for any command

The fugue help command returns helpful information for any command or subcommand. For each command, help text includes description, usage, a list of available subcommands, and flags. You can view it by using fugue [command] help, fugue [command] -h, or fugue [command] --help.

For more details, see the fugue help documentation.