Skip to main content
Use these commands to change how a chatbot answers, how the widget looks, and what it shows to visitors. This page shows the common path for each task. For every option and default, see the command reference: Personas, Instructions, Settings overview, and the settings sections after it. For what each setting does, see Chatbot settings.

Before you start

  • A SiteGPT account on the Growth plan or above. See Plans and limits.
  • The CLI installed and logged in. See Install and log in. The default access from sitegpt login is enough for the tasks on this page.
  • Your chatbot ID. Run sitegpt chatbots list to find it.

Read the current settings

The CLI prints the settings as JSON. To read one section, name it: sitegpt settings general get --chatbot YOUR_CHATBOT_ID. The sections are general, appearance, chat-mode, localization, user-data, lead-form, human-support, and webhooks. To change a section, use update with flags, or pass a JSON file with --file. set does the same as update. Check that it works: The output is JSON with one object for each section.

Change the persona

A persona sets the tone and style of the answers. The chatbot uses one persona at a time. See Write instructions.
1

Add a persona

You can pass the text with --instructions "..." instead of --file. The CLI prints the new persona ID.
2

Use the persona

Check that it works: The CLI prints Using persona with the ID and title. sitegpt personas get --chatbot YOUR_CHATBOT_ID YOUR_PERSONA_ID shows Active: yes.

Change the instructions

Instructions are rules that tell the chatbot how to answer. The chatbot uses one set of instructions at a time. See Write instructions.
1

Add a set of instructions

--temperature sets the Creativity Level of this set of instructions, from 0 to 1. Lower values give more focused answers. The default is 0.5.
2

Use the instructions

To change a set later, use instructions update with --file or --temperature. Check that it works: sitegpt instructions get --chatbot YOUR_CHATBOT_ID YOUR_INSTRUCTION_ID shows Active: yes and the temperature that you set. Then ask a test question with sitegpt messages send --chatbot YOUR_CHATBOT_ID "What can you help with?".

Change the AI model

The values are gpt-4.1 and gpt-4.1-mini. See Choose a model. Check that it works: The CLI prints Updated general settings. sitegpt settings general get --chatbot YOUR_CHATBOT_ID shows the new gptModel.

Set the support email

Check that it works: sitegpt settings general get --chatbot YOUR_CHATBOT_ID shows the new supportEmail.

Limit the messages in one conversation

This setting needs the Growth plan or above. See Plans and limits. On other plans, the command fails with RATE_LIMITS_NOT_AVAILABLE.
The maximum can be from 1 to 1000. See Keep answers on topic. Check that it works: sitegpt settings general get --chatbot YOUR_CHATBOT_ID shows rateLimits.thread with enabled set to true and your maxMessages.

Control where the widget appears

Set the domains where the widget can load, and the pages where the floating widget is hidden:
  • Repeat --allowed-domain and --excluded-path for each value.
  • Each update replaces the whole saved list.
  • --clear-allowed-domains lets the widget load on any domain. --clear-excluded-paths shows the floating widget on every page.
See Control where the chatbot appears. Check that it works: sitegpt settings general get --chatbot YOUR_CHATBOT_ID shows your allowedDomains and excludedPaths.

Change the widget look

Other common options are --title, --placeholder, --brand-text-color, --icon-size, --icon-shape, and --dark-mode. For the full list, see Settings: appearance. Some options need a plan that includes them:
  • --hide-watermark, --watermark-text, and --watermark-link fail with WATERMARK_SETTINGS_NOT_AVAILABLE on other plans.
  • --cta-text and --cta-link fail with CTA_SETTINGS_NOT_AVAILABLE on other plans.
See Plans and limits and Change the widget appearance. Check that it works: Get the chat link with sitegpt installation snippet --chatbot YOUR_CHATBOT_ID and open it. The widget shows the new color, welcome message, and position.

Upload widget icons

Pass a local file, not a URL. The file can be png, jpg, jpeg, webp, gif, avif, or svg. To remove an icon, run sitegpt icons delete --chatbot YOUR_CHATBOT_ID bot --yes. Check that it works: The CLI prints Updated with the icon name and the image URL. Open the chat link to see the icon.

Switch between AI mode and human mode

AI is the default. The chatbot answers. AGENT is human mode. Your team answers and the chatbot does not reply. See Conversations and handoff. Check that it works: The CLI prints Updated chat-mode settings. sitegpt settings chat-mode get --chatbot YOUR_CHATBOT_ID shows the new mode.

Ask for visitor details before the chat

--collect is MANDATORY, OPTIONAL, or DO_NOT_COLLECT. The default is DO_NOT_COLLECT. The form always asks for the email. --collect-name and --collect-phone add the name and the phone number. Check that it works: sitegpt settings user-data get --chatbot YOUR_CHATBOT_ID shows the new collectUserDetails. Open the chat link. The form shows before the chat starts.

Set up the lead form

--trigger is intent, unable_to_answer, or after_x_messages. The default is intent. For the other options, see Settings: lead form and Collect leads. Check that it works: sitegpt settings lead-form get --chatbot YOUR_CHATBOT_ID shows enableLeadCollection set to true.

Set up human support

1

Turn on human support

2

Tell the AI when to escalate (optional)

The dashboard field When should the AI escalate? is escalationPolicy. Put it in a JSON file:
Then pass the file:
The policy can be up to 2,000 characters. Leave it empty to use the default triggers.
For the other options, see Settings: human support and Set up human support. Check that it works: sitegpt settings human-support get --chatbot YOUR_CHATBOT_ID shows enableHumanSupport set to true.

Change the widget text

The widget text is in the localization section. You change it with a JSON file. You only need to include the text that you want to change.
See Change the language and text. Check that it works: sitegpt settings localization get --chatbot YOUR_CHATBOT_ID shows your text.

Send events to your webhooks

Your plan must include webhooks. If it does not, the command fails with WEBHOOKS_NOT_AVAILABLE. See Plans and limits.
Use --message-url and --message-token for messages, and --escalation-url and --escalation-token for escalations. See Webhooks. Check that it works: sitegpt settings webhooks get --chatbot YOUR_CHATBOT_ID shows your URLs.

Add a conversation starter

A conversation starter is a suggested question that visitors can select to start a conversation. See Conversation starters.
To show a starter only on some pages, add --page for each path, for example --page /pricing --page "/docs/*":
  • Each update replaces the starter’s whole list of pages.
  • A starter can have up to 20 paths. They follow the same rules as excluded pages.
  • --clear-pages shows the starter on every page again. You cannot use it with --page.
  • Starters cannot be escalation buttons.
Check that it works: The CLI prints Added starter and the ID. Open the chat link. The starter shows before the first message.

Add a follow-up suggestion

A follow-up suggestion is a suggested next question shown under an answer. See Follow-up suggestions.
  • To open a web page, pass --link https://example.com/docs instead of --message.
  • To hand the conversation to your team, add --escalation.
Check that it works: The CLI prints Added followup and the ID. Ask a question in the chat. The suggestion shows under the answer.

Change the order of starters or follow-up suggestions

Pass the IDs in the new order:
sitegpt followups reorder works the same way. Check that it works: The CLI prints the list in the new order.