Skip to content

cub filter edit

cub filter edit

Edit a filter in your system's editor

Synopsis

Open a filter in the editor named by the EDITOR environment variable, or vi if it is not set, as a document: the fields an update can set, with the entities the filter refers to named rather than identified by ID. When the editor exits, the filter is updated with what changed: fields left alone keep what the filter holds, and fields removed are cleared. If nothing changed, no update is made. If the filter changed since it was read, the update is refused; edit it again.

A filter with a backing Unit is edited through the Unit: the edit is saved as a Revision of the Unit, the Unit's triggers run, and the filter is then updated from the Unit, unless they report validation errors. The edit is refused when the Unit has changes the filter has not taken, unless --force is given, which applies them along with the edit.

An edit that cannot be saved is left in a file, whose name is reported.

cub filter edit <filter> [flags]

Options

      --force           edit the filter's backing Unit even though it has changes the filter has not taken, and apply them with the edit
  -h, --help            help for edit
  -o, --output string   Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --quiet           No default output.
      --verbose         Detailed output, additive with default output

Options inherited from parent commands

      --context string   The context to use for this command
      --debug            Debug output
      --space string     space to operate in, by slug or UUID. Omitted, a list or bulk operation spans the organization and a single entity is named as <space>/<slug>

SEE ALSO