Commands

tracee brand

The brand profile, assets and rules.

get

Get the brand. The brand profile (company, products, audience, voice, colours, fonts…), brand assets, the brand rules every draft is checked against, and the workspace's guardrails.

tracee brand get

Calls GET /api/v1/brand

update

Update brand profile fields. The body is the fields to change: name, website, tagline, oneLiner, category, logo, colors, fonts, products, audience, valueProps, proofPoints, contentPillars, voice, socials. A list you send replaces that whole list.

tracee brand update [--name <name>] [--website <website>] [--tagline <tagline>] [--oneLiner <oneLiner>] [--category <category>] [--logo <logo>] [--colors <colors>] [--fonts <fonts>] [--products <products>] [--audience <audience>] [--valueProps <valueProps>] [--proofPoints <proofPoints>] [--contentPillars <contentPillars>] [--voice <voice>] [--socials <socials>]
  • --namestring

    up to 120 characters

  • --websitestring

    up to 300 characters

  • --taglinestring

    up to 200 characters

  • --oneLinerstring

    up to 400 characters

  • --categorystring

    up to 120 characters

  • --logostring | null

    uriup to 1,000 characters

  • --colorsobject[]

    JSON text or @file.json.

    up to 8 items

  • --fontsobject[]

    JSON text or @file.json.

    up to 4 items

  • --productsobject[]

    JSON text or @file.json.

    up to 20 items

  • --audienceobject

    JSON text or @file.json.

  • --valuePropsstring[]

    Repeat the flag or separate values with commas.

    up to 12 itemseach up to 300 characters

  • --proofPointsstring[]

    Repeat the flag or separate values with commas.

    up to 12 itemseach up to 300 characters

  • --contentPillarsstring[]

    Repeat the flag or separate values with commas.

    up to 12 itemseach up to 300 characters

  • --voiceobject

    JSON text or @file.json.

  • --socialsobject

    JSON text or @file.json.

    any keys

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee brand update \
  --fields '{"tagline":"Posts that pay for themselves","colors":[{"role":"accent","hex":"#7459FF"}]}'
Calls PATCH /api/v1/brand

clear

Delete the brand profile. Deletes the brand profile. Brand rules stay.

tracee brand clear

Calls DEL /api/v1/brand

learn

Learn the brand from a website. Reads about ten key pages of the site, the company's past posts and what others say about it, saves logos and product shots to the library, and replaces the brand profile. Runs one to three minutes in the background: the answer is the finished profile, or status running with a run_id to follow with GET /brand/learn/{run_id}.

tracee brand learn --url <url> [--wait <seconds>]
  • --urlstringrequired

    The company's website

    up to 1,000 characters

--data <json|@file|-> sends the whole body instead of flags.--wait <seconds> waits for the job (0–290). See Background jobs.

Example
tracee brand learn --url https://acme.com
Calls POST /api/v1/brand/learn

learn-status

Follow a brand learning run. Waits for the run (see ?wait) and returns its steps, and the new profile once done.

tracee brand learn-status <run_id> [--wait <seconds>]
  • <run_id>argumentrequired

    From POST /api/v1/brand/learn

    uuid

--wait <seconds> waits for the job (0–290). See Background jobs.

Example
tracee brand learn-status $RUN_ID
Calls GET /api/v1/brand/learn/{run_id}

list add

Add an item to a brand list. Lists: products ({name, summary, features}), colors ({role, hex}), fonts ({family, role: heading|body}; family must be a Google Font Tracee knows), audience, valueProps, proofPoints, contentPillars and the other text lists.

tracee brand list add <list> --item <item>
  • <list>argumentrequired

    Available options:productsvaluePropsproofPointscontentPillarscolorsfontsaudience.industriesaudience.buyerRolesaudience.painPointsvoice.adjectivesvoice.avoid

  • --itemstring | objectrequired

    The item JSON text or @file.json.

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee brand list add proofPoints --item "Used by 4,000 marketing teams"
Calls POST /api/v1/brand/lists/{list}

list remove

Remove an item from a brand list. By item (its text, product name or hex) or by index.

tracee brand list remove <list> [--item <item>] [--index <index>]
  • <list>argumentrequired

    Available options:productsvaluePropsproofPointscontentPillarscolorsfontsaudience.industriesaudience.buyerRolesaudience.painPointsvoice.adjectivesvoice.avoid

  • --itemstring | object

    Its text, product name or hex JSON text or @file.json.

  • --indexinteger

    Instead of item

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee brand list remove proofPoints \
  --item "Used by 4,000 marketing teams"
Calls POST /api/v1/brand/lists/{list}/remove

assets add

Add a brand asset. Adds a public https image or video to the library as a brand asset with a role (logo, product, people, social, other).

tracee brand assets add --url <url> --role <role> [--name <name>] [--alt-text <alt_text>]
  • --urlstringrequired

    A public https image or video

    up to 1,000 characters

  • --rolestringrequired

    Available options:logoproductpeoplesocialother

  • --namestring

    up to 200 characters

  • --alt-textstring

    up to 500 characters

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee brand assets add \
  --url https://acme.com/logo.png \
  --role logo \
  --name "Acme logo"
Calls POST /api/v1/brand/assets

assets update

Change a brand asset's role, name or alt text.

tracee brand assets update <media_id> [--role <role>] [--name <name>] [--alt-text <alt_text>]
  • <media_id>argumentrequired

    From GET /api/v1/media/library (or the media_id POST /api/v1/media/from-url / generate_image returns).

    uuid

  • --rolestring

    Available options:logoproductpeoplesocialother

  • --namestring

    up to 200 characters

  • --alt-textstring

    up to 500 characters

--data <json|@file|-> sends the whole body instead of flags.

Example
tracee brand assets update $MEDIA_ID --role logo
Calls PATCH /api/v1/brand/assets/{media_id}

assets remove

Take an asset out of the brand. The file stays in the media library.

tracee brand assets remove <media_id>
  • <media_id>argumentrequired

    From GET /api/v1/media/library (or the media_id POST /api/v1/media/from-url / generate_image returns).

    uuid

Example
tracee brand assets remove $MEDIA_ID
Calls DEL /api/v1/brand/assets/{media_id}