fugue-client

README

Fugue API Client

This is a command line client for the Fugue API.

For CLI documentation and examples, see the Fugue docs site.

For information about enabling a client in your account, see the API User Guide. More details of the underlying Swagger API are available here.

This project is under active development and is not yet stable. Commands will change as we incorporate feedback.

Install

The easiest way to install the client is to download a prebuilt binary from the releases page.

Currently only MacOS builds are available.

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

Change file permissions:

chmod 755 /usr/local/bin/fugue

For more information, see the CLI documentation.

Environment Variables

The client uses the following required environment variables:

• FUGUE_API_ID - your API client ID
• FUGUE_API_SECRET - your API client secret

Build from Source

Install Go:

brew install go

Build the client executable:

make build

Install to $GOPATH/bin:

make install

Usage

Show usage:

fugue -h

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.

Command Documentation

• create
• delete
• get
• help
• list
• scan
• sync
• update

Aliases

You may use the shorthand env instead of environment when running commands.

For example:

fugue list envs