CLI を使い始める
brands
@orchestor-inc/cli のコマンドリファレンスです。
ブランド一覧とブランドプロフィールは同じ /v1/brands リソースを使います。自社ブランドは --relation owned で取得し、返却されたブランド ID を get と update に渡します。ワークスペース ID とブランド ID は別の ID です。
| 画面の項目 | 更新フィールド／フラグ |
|---|---|
| 説明 | notes / --notes |
| 業界 | industry / --industry |
| ブランドアイデンティティ | tags / --tags |
| プロダクトとサービス | offerings / --offerings |
| オーディエンス配分 | audience / --audience |
| ブランド名・表示名 | name・display_name |
| ドメイン・別名 | domain・domains・aliases |
| 表示色・アイコン | color_token・color_hex・identity_kind・icon_token・emoji・image_file_id |
update は指定した項目だけを変更します。配列は項目全体の置き換えです。audience は id、label、description、percentage、enabled を持つ JSON 配列です。長い説明や配列は --stdin < brand-profile.patch.json で渡せます。既存の対象者 ID を保持し、有効な対象者の割合を合計100%にします。
具体的な編集手順はブランド情報を整えるを参照してください。
コマンド一覧
orc brands list— List AI Search brandsorc brands create— Create AI Search brandorc brands suggestions list— List brand suggestionsorc brands suggestions refresh— Generate brand suggestionsorc brands suggestions generations get— Get brand suggestion generationorc brands suggestions accept— Accept a brand suggestionorc brands suggestions reject— Reject a brand suggestionorc brands get— Get AI Search brandorc brands update— Update AI Search brandorc brands delete— Soft-delete AI Search brand
orc brands list
List AI Search brands
構文
orc brands list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--relation | string | いいえ | Filter by relation. When omitted, owned and direct_competitor are returned by default.; enum: owned|direct_competitor|indirect_competitor|ignored |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc brand list
ヘルプ
orc brands list --helporc brands create
Create AI Search brand
構文
orc brands create [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--name | string | いいえ | (required) Human-readable brand name.; max 255 chars |
--domain | string | いいえ | (required) Primary domain. On create, a Domain entity with role: primary is auto-created and linked via Domain.brand_id.; max 255 chars |
--relation | string | いいえ | Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored |
--tags | string | いいえ | Body field: tags; csv |
--logo-url | string | いいえ | Optional logo URL.; (use "null" or "reset" to clear) |
--display-name | string | いいえ | Optional display name distinct from name.; (use "null" or "reset" to clear) |
--industry | string | いいえ | Optional industry tag.; (use "null" or "reset" to clear) |
--status | string | いいえ | Lifecycle status. Defaults to active; disabled preserves history and stops future execution.; enum: active|disabled |
--domains | string | いいえ | Optional full URL registry; first value becomes domain.; csv |
--aliases | string | いいえ | Alternate brand names used for matching.; csv |
--color-hex | string | いいえ | Optional UI color token in; (use "null" or "reset" to clear) |
--color-token | string | いいえ | Canonical identity color token.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red |
--identity-kind | string | いいえ | Active identity presentation mode.; enum: color|initial|icon|emoji|image |
--icon-token | string | いいえ | Icon token reference when identity_kind=icon.; (use "null" or "reset" to clear) |
--emoji | string | いいえ | Emoji glyph when identity_kind=emoji.; (use "null" or "reset" to clear) |
--image-file-id | string | いいえ | File ID reference when identity_kind=image.; (use "null" or "reset" to clear) |
--notes | string | いいえ | Free-form operator notes for this brand.; (use "null" or "reset" to clear) |
--regex-pattern | string | いいえ | Optional advanced matching regex.; (use "null" or "reset" to clear) |
--offerings | string | いいえ | Customer-visible products, services, solutions, or packages offered by the Brand.; csv |
--audience | string | いいえ | Initial Brand Profile audience composition.; JSON array of objects (use --stdin for large resources) |
--profile-suggestion-decisions | string | いいえ | Body field: profile_suggestion_decisions; (JSON object, e.g. '{"custom_id":"x"}') |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc brand create
ヘルプ
orc brands create --helporc brands suggestions list
List brand suggestions
構文
orc brands suggestions list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--status | string | いいえ | enum: pending|accepted|rejected |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc brand suggestion-list
ヘルプ
orc brands suggestions list --helporc brands suggestions refresh
Generate brand suggestions
構文
orc brands suggestions refresh [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--wait | boolean | いいえ | Wait for an asynchronous operation to finish and print its result |
--timeout | string | いいえ | Maximum wait duration (for example 30s or 5m) |
--poll-interval | string | いいえ | Delay between status requests (default: 5s) 既定値: 5s |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc brands suggestions refresh --helporc brands suggestions generations get
Get brand suggestion generation
構文
orc brands suggestions generations get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc brands suggestions generations get --helporc brands suggestions accept
Accept a brand suggestion
構文
orc brands suggestions accept <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--edit-name | string | いいえ | Body field: edit_name; max 255 chars |
--relation | string | いいえ | Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc brands suggestions accept --helporc brands suggestions reject
Reject a brand suggestion
構文
orc brands suggestions reject <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc brands suggestions reject --helporc brands get
Get AI Search brand
構文
orc brands get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Brand ID. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc brand get
ヘルプ
orc brands get --helporc brands update
Update AI Search brand
構文
orc brands update <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--name | string | いいえ | Body field: name; max 255 chars |
--domain | string | いいえ | Body field: domain; max 255 chars |
--relation | string | いいえ | Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored |
--tags | string | いいえ | Body field: tags; csv |
--logo-url | string | いいえ | Body field: logo_url; (use "null" or "reset" to clear) |
--display-name | string | いいえ | Body field: display_name; (use "null" or "reset" to clear) |
--industry | string | いいえ | Body field: industry; (use "null" or "reset" to clear) |
--status | string | いいえ | Lifecycle transition. disabled preserves history and stops future execution; returning to active does not backfill the disabled interval.; enum: active|disabled |
--domains | string | いいえ | Body field: domains; csv |
--aliases | string | いいえ | Body field: aliases; csv |
--color-hex | string | いいえ | Body field: color_hex; (use "null" or "reset" to clear) |
--notes | string | いいえ | Body field: notes; (use "null" or "reset" to clear) |
--regex-pattern | string | いいえ | Body field: regex_pattern; (use "null" or "reset" to clear) |
--color-token | string | いいえ | 表示色のトークン。値は --help を参照 |
--identity-kind | string | いいえ | color・initial・icon・emoji・image |
--icon-token | string | いいえ | アイコンのトークン。null で解除 |
--emoji | string | いいえ | 表示する絵文字。null で解除 |
--image-file-id | string | いいえ | アップロード済み画像のファイル ID。null で解除 |
--offerings | string | いいえ | プロダクト・サービスの完全な一覧。CSV。カンマを含む値は --stdin の JSON 配列で指定 |
--audience | string | いいえ | オーディエンスの完全な JSON 配列。最大20件 |
--profile-suggestion-decisions | string | いいえ | 提案の判断を保存する JSON オブジェクト。値は accepted・rejected |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc brand update
ヘルプ
orc brands update --helporc brands delete
Soft-delete AI Search brand
構文
orc brands delete <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc brand delete
ヘルプ
orc brands delete --help