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.
- Manage cloud provider accounts.
- Display job history for a Fugue process.
- Initialize a Fugue project.
- Install the Fugue Conductor.
- Kill a running 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.
- Check the status of the Fugue system.
- 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 version of internal components packaged with the CLI:
- 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
- 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 OSX and Linux terminals. Results may vary on Windows platforms.