Skip to main content

Documentation Index

Fetch the complete documentation index at: https://sitegpt.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

The SiteGPT CLI is the first-party command line interface for managing SiteGPT from a terminal, script, or AI assistant. It lets you create chatbots, add training content, configure appearance and behavior, inspect conversations, manage leads, invite team members, and review account usage without opening the dashboard. The installed command is: 
sitegpt

​
When to use the CLI

Automate setup

Create a chatbot, add website knowledge, configure settings, upload icons, and verify everything from one workflow.

Manage knowledge

Add links, websites, sitemaps, files, YouTube videos, text snippets, cloud sources, and custom responses.

Run support operations

Review conversations, tags, messages, leads, escalations, and support handoff state.

Use with AI agents

Give personal AI agents a scoped CLI profile, a skill file, JSON output, and safe workflows for operating SiteGPT.

​
Quick start

1

Install the CLI

npm install -g @sitegpt/cli
sitegpt --version
2

Log in

sitegpt login
The CLI opens a SiteGPT approval page in your browser. After approval, it stores a local token profile on your machine.
3

Verify authentication

sitegpt whoami
sitegpt profiles list
4

List your chatbots

sitegpt chatbots list
5

Use JSON for scripts and agents

sitegpt chatbots list --json
sitegpt knowledge documents list --chatbot <chatbot-id> --json

​
Common workflow

# Authenticate
sitegpt login
sitegpt whoami

# Create a chatbot
sitegpt chatbots create "Support Bot" --description "Answers customer support questions" --json

# Add knowledge
sitegpt knowledge sitemap add --chatbot <chatbot-id> https://example.com/sitemap.xml --json
sitegpt knowledge files add --chatbot <chatbot-id> ./faq.pdf ./policy.docx

# Customize behavior
sitegpt personas add --chatbot <chatbot-id> --title "Support specialist" --file ./persona.md
sitegpt instructions add --chatbot <chatbot-id> --file ./instructions.md --temperature 0.3

# Configure appearance and prompts
sitegpt settings appearance update --chatbot <chatbot-id> --brand-color "#155DEE"
sitegpt starters add --chatbot <chatbot-id> --title "Pricing" --message "Tell me about pricing."

# Test the bot
sitegpt messages send --chatbot <chatbot-id> "How do I contact support?"

​
Command groups

AreaCommands
Auth and local configlogin, logout, whoami, profiles
Accountaccount, usage, limits, billing, tokens
Chatbotschatbots, dashboard, installation, icons, settings, personas, instructions
Knowledgeknowledge documents, knowledge links, knowledge website, knowledge sitemap, knowledge youtube, knowledge text, knowledge files, knowledge sources, knowledge sync-jobs, knowledge custom-responses
Support operationsconversations, messages, tags, leads, starters, followups, members, member-invites
See the full command reference for every command and option. If you want a personal AI agent to operate SiteGPT for you, start with Use with AI agents.

​
Global options

These options work across command groups:
OptionDescription
--jsonPrint machine-readable JSON. Use this for scripts and agents.
--profile <name>Use a named local CLI profile.
-p <name>Alias for --profile.
--api-base <url>Override the SiteGPT API base URL for one command.
-v, --versionPrint the installed CLI version.
-h, --helpShow contextual help for the current command level.

​
Environment variables

VariableDescription
SITEGPT_API_TOKENToken override for the current command.
SITEGPT_API_BASEAPI base URL override. Defaults to https://sitegpt.ai when no profile value is set.
SITEGPT_PROFILEProfile name override.

​
Contextual help

Every command level has help built in. This is important for both people and AI agents because the help output includes enum values, defaults, and examples. 
sitegpt --help
sitegpt knowledge --help
sitegpt knowledge documents --help
sitegpt settings appearance --help
sitegpt conversations --help
Use --json whenever you need IDs, cursors, nested data, or output that an automation can parse reliably.