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 the prebuilt fugue binary from the releases page on GitHub:

_images/fugue-client-download.png

2. cd into the directory where you downloaded fugue and move the binary to a location in your $PATH, such as /usr/local/bin:

mv fugue /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

5. You should be able to run the fugue executable now:

fugue --version

If you get an error message that the application cannot be opened, see these instructions.

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.

Installation Error Message

On certain versions of macOS, you might see an error message that “fugue cannot be opened because the developer cannot be verified.”

You can safely run fugue by taking the following steps:

1. Select “Cancel” to dismiss the error message.

_images/cli-install-error-1.png

2. In macOS, access System Preferences > Security & Privacy and select the General tab.

3. Click the lock in the lower-left corner to unlock your computer and make changes.

4. Click “Allow Anyway.”

_images/cli-install-error-2.png

5. Run fugue again:

fugue --version

6. macOS will ask you to confirm that you want to open it. Click “Open.”

_images/cli-install-error-3.png

7. You can now run fugue commands.