fm organization

Reference for the fm organization command group (auto-generated from fm organization --help).

fm organization

Manage settings that apply across every tenant of an organization.

The organization is the one that owns the active tenant (fm tenant current);
pass --organization <id> to name another one you belong to.

Usage:
  fm organization [command]

Aliases:
  organization, org, organizations

Available Commands:
  tag-colors  Manage the colours tags are shown in

Flags:
  -h, --help                  help for organization
      --organization string   organization ID (default: the organization that owns the active tenant)

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm organization [command] --help" for more information about a command.

fm organization tag-colors

Manage the organization's tag colour rules.

A rule gives a tag a background colour wherever it is shown — the portal, and
fm's own tag views on a colour terminal — in every tenant of the organization,
so env=prod looks the same everywhere. A rule matches either one value of a key
(--value) or every value of it (--any-value); for a tag key=value the rule for
exactly that value wins over the key's any-value rule. The tag text is always
shown, so colour is never the only signal.

Rules are display only: nothing on the platform reads them to decide anything.
Reading them needs membership of the organization; changing them needs an admin
or owner role. An API key needs the organizations:read / organizations:write
scope.

Usage:
  fm organization tag-colors [command]

Aliases:
  tag-colors, tag-colours, tag-color, tag-colour

Available Commands:
  delete      Delete a tag colour rule
  get         Show one tag colour rule
  list        List the organization's tag colour rules
  set         Give a tag a colour (create or update its rule)

Flags:
  -h, --help   help for tag-colors

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (default: the organization that owns the active tenant)
  -o, --output string         output format: table, json, yaml, wide (default "table")
  -q, --quiet                 suppress non-essential output
      --tenant string         tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

Use "fm organization tag-colors [command] --help" for more information about a command.

fm organization tag-colors delete

Delete a tag colour rule, named by its ID or by the tag it colours.

By tag, exactly one of --value and --any-value is required, as on 'set': the
any-value rule of a key and the rule for one of its values are different rules.

Examples:
  fm organization tag-colors delete 7d1c...
  fm organization tag-colors delete --key env --value prod
  fm organization tag-colors delete --key env --any-value

Usage:
  fm organization tag-colors delete [rule-id] [flags]

Flags:
      --any-value      colour every value of the key
  -h, --help           help for delete
      --key string     the tag key the rule colours (case-sensitive)
      --value string   the one tag value the rule colours (may be empty)

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (default: the organization that owns the active tenant)
  -o, --output string         output format: table, json, yaml, wide (default "table")
  -q, --quiet                 suppress non-essential output
      --tenant string         tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm organization tag-colors get

Show one tag colour rule

Usage:
  fm organization tag-colors get <rule-id> [flags]

Flags:
  -h, --help   help for get

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (default: the organization that owns the active tenant)
  -o, --output string         output format: table, json, yaml, wide (default "table")
  -q, --quiet                 suppress non-essential output
      --tenant string         tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm organization tag-colors list

List the organization's tag colour rules, ordered by key (the any-value rule
first, then by value).

Without --organization the rules are those of the organization that owns the
active tenant, read in one request through the tenant.

On a colour terminal each rule's tag is shown in its colour. Under -o json or
-o yaml the rules are printed as a bare array of rule objects (the API's
"rules" list, not its envelope); a rule matching every value of its key has
"value": null.

Usage:
  fm organization tag-colors list [flags]

Flags:
  -h, --help   help for list

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (default: the organization that owns the active tenant)
  -o, --output string         output format: table, json, yaml, wide (default "table")
  -q, --quiet                 suppress non-essential output
      --tenant string         tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)

fm organization tag-colors set

Give a tag a colour: create the rule for --key and --value (or --any-value),
or, when the organization already has a rule for exactly that, change its
colour. Running it again with the same arguments changes nothing.

Exactly one of --value and --any-value is required, so a rule never matches
more than you meant: --value names one value (it may be empty: --value ""),
--any-value matches every value of the key. A rule for one value wins over the
key's any-value rule.

--color is a hex colour, #RRGGBB. Quote it ('#1f6feb'): an unquoted # starts a
shell comment. The # may also be left out (1f6feb). The text colour is chosen
for contrast, black or white.

Keys starting with frostmoln_ or frostmoln- (lower case) are the platform's
and cannot be coloured. A key is at most 255 characters and a value at most
256; an organization has at most 200 rules.

Examples:
  fm organization tag-colors set --key env --value prod --color '#d73a49'
  fm organization tag-colors set --key env --any-value --color 6e7781
  fm organization tag-colors set --key team --value payments --color '#1f6feb' --organization 0c4f...

Usage:
  fm organization tag-colors set [flags]

Flags:
      --any-value      colour every value of the key
      --color string   background colour, #RRGGBB (quote it) or RRGGBB
  -h, --help           help for set
      --key string     the tag key the rule colours (case-sensitive)
      --value string   the one tag value the rule colours (may be empty)

Global Flags:
      --config string         config file (default is $HOME/.fm/config.yaml)
  -d, --debug                 enable debug/verbose output
      --no-color              disable colored output
      --organization string   organization ID (default: the organization that owns the active tenant)
  -o, --output string         output format: table, json, yaml, wide (default "table")
  -q, --quiet                 suppress non-essential output
      --tenant string         tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)