property

Usage

fugue [global options] property [options] (<FID> | <alias>) <key> [--set <value>]

Arguments

<FID> | <alias>
FID or alias of the target process
<key>

The process property to get or set

Available properties:

alias: The process’s alias

Options

Global options are detailed here.

--set <value>
Set the <key> to the provided <value>
--json
Emit output as JSON. The JSON flag displays command output in JSON format, which is useful for automation.
--help
Show help text. The help flag is available throughout the CLI in both an application-level and command-level context. It enables a user to view help text for any command within the Fugue CLI.

Definition

The property command gets or sets a property of a Fugue process.

Currently, the only supported property is alias. alias returns a process’s alias or changes it.

Examples

Returning the alias of a process

If you know the FID of a process and you want to find out what its alias is, you can use property with alias:

$ fugue property ce757615-5b75-49eb-a5a5-0733eed8b0d3 alias

The CLI returns the alias:

"staging"

To return the alias as JSON, use the --json flag:

$ fugue property --json ce757615-5b75-49eb-a5a5-0733eed8b0d3 alias

The CLI returns the alias as JSON:

{
    "fid": "ce757615-5b75-49eb-a5a5-0733eed8b0d3",
    "alias": "staging"
}

Changing the alias of a process

If you want to change the alias of a running process, you can use property with alias. This command allows you to update the alias with no impact to your infrastructure.

Say you have a process with the alias staging, but you need to change it to a new alias, develop.

To change an alias by providing the process’s FID, follow this format: fugue property <FID> alias --set <value>

$ fugue property ce757615-5b75-49eb-a5a5-0733eed8b0d3 alias --set develop

The CLI returns the new alias:

"develop"

As with other commands, you can also substitute an alias for a FID when invoking this command. For example, for a process with the alias myProcess, this command would change the alias to develop.

$ fugue property myProcess alias --set develop

To return the output as JSON, use the --json flag and provide either the FID or the old alias in this format: fugue property --json <FID | alias> alias --set <value>

$ fugue property --json myProcess --set develop

The CLI returns the new alias as JSON:

{
    "fid": "ce757615-5b75-49eb-a5a5-0733eed8b0d3",
    "alias": "develop"
}

Alias format

An alias must meet the following criteria:

  • It must be unique. If an alias already exists, the Fugue CLI returns an error.
  • It must not match the format of a UUID (i.e., 00000000-0000-0000-0000-000000000000).