CLI commands for search, broadcasts, tickets, assistant and credentials

These five commands arrived in CLI version 0.4, so every command and flag on this page is (0.4+). If hive3 search prints Unknown command: search, your installed CLI is older; run hive3 update --check. Shared conventions such as output, exit codes, --file and --account are on the main CLI command reference.

Keys created before the broadcast, ticket, AI and credential scopes existed do not include them. Sign in again with hive3 login to get a key that does. Search uses the existing resources:read scope. When you target another account with --account, each command also needs communities:read (reads) or communities:write (writes) and your current role. See Act on another account.

#Search

• --type is all (default), accounts, events, courses, content, quests or jobs.
• --limit is a whole number from 1 to 50 (default 20).
• The query is 1 to 100 characters. Several words are joined with spaces, so quotes are optional; use them to stop your shell from splitting special characters.
• Each result has a type (account, event, and so on) and an id. Use --cursor with the nextCursor of the previous response to read more.

hive3 search "design guild" --type accounts --limit 10
hive3 search portfolio night --type events

#Broadcasts

Broadcasts are emails to an account's opted-in members. You must be owner, admin or moderator of the account. See Broadcasts for the API and Email broadcasts for the app.

• --body-mode is editor (default) or html. --body-html is cleaned the same way as in the app editor; without it, HTML is built from the paragraphs of --body-text.
• --subject is 1 to 180 characters. --hero-image-url must be an http or https URL. --remove-hero-image clears the image and cannot be combined with --hero-image-url.
• With --file, the file is read first and flags override it. The file uses subject, bodyText, bodyHtml, bodyMode and heroImageUrl.
• Only drafts can be edited. There is no delete. A send reaches at most 5,000 opted-in accepted members.
• send requires --yes because an immediate send cannot be undone once it starts. --at takes an ISO 8601 date-time such as 2026-12-01T15:00:00Z from 1 minute to 90 days ahead; cancel undoes a scheduled send.
• How often you can send depends on the plan: Honey Bee every 30 days, Swarm every 14, Royal Hive every 7. Worker Bee cannot send. broadcasts audience shows when the next send is allowed.
• create allows 30 writes per minute, and test 10 per hour.

{
  "subject": "November news",
  "bodyText": "Portfolio night is back.\n\nSee you on the 12th."
}

hive3 broadcasts audience --account design-guild
hive3 broadcasts create --file broadcast.json --account design-guild --idempotency-key november-news
hive3 broadcasts test "<broadcast-id>"
hive3 broadcasts send "<broadcast-id>" --yes --at 2026-11-02T15:00:00Z
hive3 broadcasts cancel "<broadcast-id>"

#Tickets

Tickets are the paid entries set up on an account's events, courses and quests. Creating tickets, checkout and refunds are not available from the CLI.

• --amount is a positive decimal with at most two decimals, such as 12.50. --currency is a three-letter code, such as USD; it is converted to upper case.
• --status is active or inactive. Turning a ticket back on needs a seller on Honey Bee or above.
• Managing tickets is for owners and admins; moderators cannot.

hive3 tickets list --account design-guild
hive3 tickets update "<ticket-id>" --amount 12.50 --currency USD
hive3 tickets update "<ticket-id>" --status inactive

#AI assistant

Each account can have one assistant that answers questions from documents you provide. It needs a Honey Bee or higher account, and the first update creates it. Chatting with the assistant is not available from the CLI. See AI assistant for the app.

• --visibility is public, protected or private. The name is 1 to 80 characters and the description up to 2,000.
• Documents are PDF, DOCX or plain text up to 5 MB, and up to 50 per assistant. The CLI infers the type from .pdf, .docx and .txt; pass --content-type for other extensions. A file over the limit is refused before it is uploaded, and the upload address is checked the same way as in hive3 upload.
• The assistant is limited to 20 saves per minute.

hive3 assistant update --name "Guild helper" --description "Answers member questions" --visibility private
hive3 assistant documents add ./faq.pdf
hive3 assistant documents
hive3 assistant documents delete "<document-id>" --confirm "<document-id>"

#Credentials

You can read credentials and award custom ones. Creating, editing, minting, deploying and claiming credentials are not available from the CLI; claiming happens in the app. See Create and award credentials.

• --handles is a comma-separated list of 1 to 50 handles. A leading @ is allowed: @alice,bob.
• Only custom (general) credentials can be awarded. People who already hold the award are skipped and not notified again, so repeating the command is safe. The response has awarded and notFound.
• award requires --yes because it cannot be undone through the CLI.
• Awarding needs owner, admin or moderator on the credential's account.

hive3 credentials list --account design-guild
hive3 credentials award "<credential-id>" --handles @alice,bob --yes
hive3 credentials claimable