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.
What’s the Fugue CLI?¶
The Fugue software has two components:
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.
If you encounter an error message stating “This client and the Conductor are incompatible,” see the Troubleshooting Guide.
- Manage cloud provider accounts.
- Display job history for a Fugue process.
- Initialize a Fugue project.
- Install the Fugue Conductor.
- Kill a running Fugue process.
- Get details on the status of a Fugue process.
- Manage role-based access control policy for Fugue.
- Get or set a property of a Fugue process.
- Resume a suspended Fugue process.
- Release a process from Fugue management.
- Create a Fugue process by running a composition file.
- Modify Conductor runtime behavior.
- Manage the API server.
- Check the status of the Fugue system.
- Access Fugue support tools.
- Suspend a running Fugue process.
- Uninstall the Fugue Conductor.
- Update a running Fugue process with a composition file.
- Upgrade the Fugue Conductor.
- Assume a
<user_id>for Fugue commands.
fugue [--version | -h | --help] fugue [global options] command
Options Without Commands¶
fugue executable accepts the following options without a
Display the AMI ID of the current Conductor (Note: the AMI ID will only appear after a Conductor is installed), along with the version of internal components packaged with the CLI:
- The Fugue Client, which is the package containing the other components
- The Fugue CLI itself
- Vars, Fugue’s distributed variable service
lwc, the Ludwig compiler
lwdoc, an internal documentation tool
- Fugue Transcriber, a tool to create compositions from existing resources
- Fugue Composer, a visualization tool for exploring compositions
Conductor AMI: ami-b1d024cb Fugue Client Version: 0.45.0 Fugue CLI Version: 1.21.3-4502-906af6ee1e884cd21075605d35eff15e97cf2385 VARs Version: 6.7.0-3601-3287b6c50a89cf731b98251f6a7c8025f9135a4f LWDoc Version: 0.43.1 LWC Version: 0.43.1 Transcriber Version: 1.4.6-658-a0481ef84d14d447389ec161f122aa488bdb1e16 Composer Version: 0.6.8-1501
- 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¶
fugue executable accepts the following options preceding any
- Specify the AWS region in which to execute the command. For more information about setting the region, see this list.
- 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.
- Use color output. This is expected to work on macOS and Linux terminals. Results may vary on Windows platforms.
- Perform fugue commands as another user.