Getting started

perception-attributes

This page is the command reference for @orchestor-inc/cli.

Commands

  • orc perception-attributes list — List managed perception attributes
  • orc perception-attributes create — Create a custom attribute
  • orc perception-attributes update — Rename an attribute
  • orc perception-attributes delete — Hide an attribute

orc perception-attributes list

Lists observed and custom attributes. The id returned for an observed attribute can be passed directly to update or delete.

Usage

orc perception-attributes list --brand-id <brand-id> [flags]

Flags

FlagTypeRequiredDescription
--brand-idstringYesTarget brand ID

See global flags for output and request options. Use --help to check the flags supported by this command.

orc perception-attributes create

Creates a custom attribute for future observations. A brand can have at most 10 active custom attributes.

Usage

orc perception-attributes create --brand-id <brand-id> --label <label> [flags]

Flags

FlagTypeRequiredDescription
--brand-idstringYesTarget brand ID
--labelstringYesAttribute label with 2–80 characters
--idempotency-keystringNoUnique key that prevents duplicate creation on retry

See global flags for output and request options. Use --help to check the flags supported by this command.

orc perception-attributes update

Renames a persisted attribute or an observed attribute. Its original source_label and existing evidence association remain unchanged.

Usage

orc perception-attributes update <id> --brand-id <brand-id> --label <label> [flags]

Arguments

ArgumentRequiredDescription
idYesAttribute ID returned by list

Flags

FlagTypeRequiredDescription
--brand-idstringYesTarget brand ID
--labelstringYesNew display label with 2–80 characters

See global flags for output and request options. Use --help to check the flags supported by this command.

orc perception-attributes delete

Hides an attribute from reports and source evidence. Historical observations and the original source_label are retained.

Usage

orc perception-attributes delete <id> --brand-id <brand-id> [flags]

Arguments

ArgumentRequiredDescription
idYesAttribute ID returned by list

Flags

FlagTypeRequiredDescription
--brand-idstringYesTarget brand ID
--yesbooleanNoSkip confirmation in non-interactive use

See global flags for output and request options. Use --help to check the flags supported by this command.