CLI Reference

Overview

What’s in This Guide?

The CLI Reference Guide contains at-a-glance information about using the Fugue CLI, including description, options, usage, and examples for each CLI command.

For information about CLI logging, see Logging. For background information on how Fugue works, see the User Guide.

What’s the Fugue CLI?

The Fugue software has two components:

  • The Fugue CLI, which runs locally, on your machine
  • The Fugue Conductor, which runs remotely, in AWS

As the front end of the system, the CLI is where you enter commands. The Conductor is the back end, or what handles the commands. You use the CLI to tell the Conductor what to do, such as creating, modifying, or destroying infrastructure.

Commands

account
Manage cloud provider accounts.
history
Display job history for a Fugue process.
init
Initialize a Fugue project.
install
Install the Fugue Conductor.
kill
Kill a running Fugue process.
policy
Manage role-based access control policy for Fugue.
property
Get or set a property of a Fugue process.
resume
Resume a suspended Fugue process.
release
Release a process from Fugue management.
run
Create a Fugue process by running a composition file.
status
Check the status of the Fugue system.
suspend
Suspend a running Fugue process.
uninstall
Uninstall the Fugue Conductor.
update
Update a running Fugue process with a composition file.
upgrade
Upgrade the Fugue Conductor.
user
Assume a <user_id> for Fugue commands.

Usage

fugue [--version | -h | --help]
fugue [global options] command

Options Without Commands

The fugue executable accepts the following options without a command:

--version

Display the version of internal components packaged with the CLI:

  • The Fugue CLI itself
  • Vars, Fugue’s distributed variable service
  • lwc, the Ludwig compiler
  • lwdoc, an internal documentation tool
-h | --help
Show help text. The help flag is available throughout the CLI in both global and command-specific contexts. In this use (fugue -h) it provides basic help and an overview of commands. When used following a command (fugue init -h), it displays help text for that specific command.

Global Options Preceding Commands

The fugue executable accepts the following options preceding any command:

-v | --verbose
Be verbose. The verbose flag displays command output in verbose mode, providing additional information for a number of Fugue CLI commands. Within Fugue, verbose output describes AWS API calls and responses.
--color
Use color output. This is expected to work on OSX and Linux terminals. Results may vary on Windows platforms.