SiteGPT CLI - SiteGPT Docs

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.

Try before signup

Let an AI agent create a temporary chatbot from a website before the user has a SiteGPT account.

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.

Connect MCP server

Connect Claude and other remote MCP clients to SiteGPT with browser-based OAuth approval.

Choose your CLI flow

Situation	Start here
The user does not have a SiteGPT account yet or wants to try SiteGPT from a website URL	Agent-first onboarding
The user already has a SiteGPT account, token, or saved profile	Install and log in

New customers can still log in first and create their first chatbot directly inside an account. If the goal is to see a working chatbot before signup, use agent-first onboarding.

Quick start: no account yet

Install the CLI

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

Start onboarding

sitegpt onboarding start https://example.com --json

Save data.workspace.id, data.workspace.chatbotId, data.apiToken, and data.onboardingUrl from the response.

Use the temporary token

SITEGPT_API_TOKEN=<temporary-token> sitegpt onboarding status <workspace-id> --json
SITEGPT_API_TOKEN=<temporary-token> sitegpt knowledge sitemap add --chatbot <chatbot-id> https://example.com/sitemap.xml --json

Share the onboarding URL

Configure and test the chatbot first. Then share data.onboardingUrl so the human can preview and claim it.

Quick start: existing account

Install the CLI

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

sitegpt login

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

Verify authentication

sitegpt whoami
sitegpt profiles list

List your chatbots

sitegpt chatbots list

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

Area	Commands
Auth and local config	`login`, `logout`, `whoami`, `profiles`
Agent-first onboarding	`onboarding`
Account	`account`, `usage`, `limits`, `billing`, `tokens`
Chatbots	`chatbots`, `dashboard`, `installation`, `icons`, `settings`, `personas`, `instructions`
Knowledge	`knowledge documents`, `knowledge links`, `knowledge website`, `knowledge sitemap`, `knowledge youtube`, `knowledge text`, `knowledge files`, `knowledge sources`, `knowledge sync-jobs`, `knowledge custom-responses`
Support operations	`conversations`, `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. If your AI app supports remote MCP servers, use the MCP Server.

Global options

These options work across command groups:

Option	Description
`--json`	Print 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`, `--version`	Print the installed CLI version.
`-h`, `--help`	Show contextual help for the current command level.

Environment variables

Variable	Description
`SITEGPT_API_TOKEN`	Token override for the current command.
`SITEGPT_API_BASE`	API base URL override. Defaults to `https://sitegpt.ai` when no profile value is set.
`SITEGPT_PROFILE`	Profile 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.

​When to use the CLI

Automate setup

Try before signup

Manage knowledge

Run support operations

Use with AI agents

Connect MCP server

​Choose your CLI flow

​Quick start: no account yet

​Quick start: existing account

​Common workflow

​Command groups

​Global options

​Environment variables

​Contextual help

When to use the CLI

Choose your CLI flow

Quick start: no account yet

Quick start: existing account

Common workflow

Command groups

Global options

Environment variables

Contextual help