help

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.

Note

You can get help for a command by running any of the following:

  • fugue [command] help

  • fugue [command] -h

  • fugue [command] --help

help

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
  test        Test custom rules
  update      Update a resource

Flags:
  -h, --help            help for fugue
      --output string   The formatting style for command output [table | json] (default "table")

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

help help

Help provides help for any command in the application.
Simply type fugue help [path to command] for full details.

Usage:
  fugue help [command] [flags]

Flags:
  -h, --help   help for help

Global Flags:
      --output string   The formatting style for command output [table | json] (default "table")

Examples

Getting fugue help

You can use help with the base fugue command:

fugue help

This returns the output above, which lists all available fugue commands.

Getting create subcommand help

As an example, you can use help with create and each of its subcommands:

fugue create help
fugue create aws help
fugue create aws environment help
fugue create azure help
fugue create azure environment help
fugue create google environment help

This works for any command and/or subcommand.