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.

SiteGPT CLI is designed to be used by both people and personal AI agents. If your AI assistant can run terminal commands, you can give it SiteGPT CLI access and ask it to create chatbots, add knowledge, update settings, review conversations, manage leads, and maintain your SiteGPT account. The recommended pattern is simple:
  1. Install the CLI on the machine where the agent runs.
  2. Log in with a named, scoped profile.
  3. Give the agent the SiteGPT CLI skill file.
  4. Ask the agent to use sitegpt ... --json commands and confirm destructive actions.

​
What your agent needs

Your AI agent needs three things:
RequirementWhy it matters
Terminal accessThe agent uses the sitegpt command to perform actions.
A SiteGPT CLI profileThe profile stores the API base URL and scoped token locally.
CLI instructionsThe skill file teaches the agent the command groups, safe workflows, and playbooks.
The public SiteGPT CLI skill file is available at: 
https://sitegpt.ai/agents/sitegpt-cli-skill.md
Some AI products call this a skill file, project instruction, custom instruction, memory, or tool guide. The name varies, but the idea is the same: give the agent this document before asking it to manage SiteGPT.
1

Install the CLI

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

Create a dedicated profile for the agent

Use a named profile instead of your default profile. This makes it obvious when the agent is operating SiteGPT.
sitegpt login --profile sitegpt-agent
The browser approval page lets you review the access being requested before creating the token.
3

Verify the profile

sitegpt --profile sitegpt-agent whoami
sitegpt profiles list
4

Give the agent the skill file

Tell your agent to read this URL before using SiteGPT:
https://sitegpt.ai/agents/sitegpt-cli-skill.md
5

Ask for JSON output

Tell the agent to use --json whenever it needs IDs or structured data.
sitegpt --profile sitegpt-agent chatbots list --json

​
Copy-ready agent instruction

Paste this into your personal AI agent’s instructions, project knowledge, or chat before asking it to work with SiteGPT: 
You can manage my SiteGPT account with the SiteGPT CLI.

Before running commands, read the SiteGPT CLI skill file:
https://sitegpt.ai/agents/sitegpt-cli-skill.md

Use the profile named sitegpt-agent unless I tell you otherwise.
Prefer --json for commands where you need IDs or structured output.
Do not ask me to paste API tokens into chat. Use the saved CLI profile.
Confirm before deleting chatbots, deleting knowledge, revoking tokens, removing members, or making broad account changes.
When creating a chatbot from a website, inspect the website first, prefer sitemap knowledge when available, extract brand colors/icons from raw HTML/assets, then configure knowledge, persona, instructions, appearance, starters, and followups.
If you use a different profile name, replace sitegpt-agent in the instruction.

​
Safer authentication choices

Use the smallest access level that can complete the job.
Agent typeSuggested profileSuggested access
Chatbot setup agentsetup-agentChatbot, knowledge, settings, personas, instructions, starters, and followups read/write.
Knowledge maintenance agentknowledge-agentChatbot read plus knowledge read/write/delete for selected chatbots.
Support operations agentsupport-agentConversations, messages, tags, leads, and chatbot read access.
Account review agentaccount-agentAccount, usage, billing, and member read access.
For a chatbot-scoped knowledge profile: 
sitegpt login \
  --profile knowledge-agent \
  --chatbot <chatbot-id> \
  --scope account:read \
  --scope chatbots:read \
  --scope knowledge:read \
  --scope knowledge:write \
  --scope knowledge:delete
For broad end-to-end chatbot creation, use browser approval and review the permissions shown on the approval page: 
sitegpt login --profile setup-agent --full-access
Full access is convenient for trusted local agents, but least-privilege scoped profiles are better for repeated workflows.

​
Manual token setup

If you prefer to choose permissions in the dashboard first:
1

Create a token in SiteGPT

Open the SiteGPT dashboard, go to Agents, click Create token, choose the access level or custom scopes, and optionally restrict the token to specific chatbots.
2

Copy the token once

SiteGPT shows the plaintext token only once. Store it somewhere safe before closing the modal.
3

Save it into an agent profile

sitegpt login --profile sitegpt-agent --token <sitegpt-api-token>
4

Verify it

sitegpt --profile sitegpt-agent whoami
After this, your agent can use the profile without seeing the raw token.

​
Example prompts for your agent

​
Create a chatbot from a website

Use the SiteGPT CLI with profile setup-agent. Create a new customer-support chatbot for https://example.com. Inspect the site first, prefer sitemap knowledge if available, extract the brand color and icon from raw HTML/assets, then configure persona, instructions, appearance, conversation starters, followups, and run a test message. Show me the final chatbot ID and what you configured.

​
Add and verify knowledge

Use the SiteGPT CLI with profile knowledge-agent. Add this documentation sitemap to chatbot <chatbot-id>: https://docs.example.com/sitemap.xml. Then list the new knowledge documents, wait for ingestion if needed, and resync any failed documents. Use JSON output for document IDs.

​
Review recent support activity

Use the SiteGPT CLI with profile support-agent. Review recent conversations for chatbot <chatbot-id>, summarize open issues, list new leads, and tag conversations that need human follow-up. Do not delete anything without asking me first.

​
Update bot behavior

Use the SiteGPT CLI with profile setup-agent. Review the current persona, instructions, starters, and followups for chatbot <chatbot-id>. Suggest improvements for a concise support tone, then apply the approved changes.

​
What agents can manage

AreaWhat the agent can do
ChatbotsCreate, list, inspect, update, delete, open dashboard links, fetch install snippets, upload icons.
KnowledgeAdd links, websites, sitemaps, files, YouTube videos, text, cloud data sources, custom responses, resync documents, update document config.
CustomizationManage personas, instructions, settings, starters, followups, and visual appearance.
SupportList conversations, inspect messages, send visitor messages, escalate threads, manage tags, and review leads.
AccountView usage, limits, billing invoices, members, invites, and API tokens when scoped.
Use the command reference for the complete command surface.

​
Best practices

  • Use named profiles for agents, such as setup-agent, knowledge-agent, and support-agent.
  • Prefer --json when the agent needs IDs, document states, token IDs, or nested data.
  • Ask agents to run sitegpt profiles list and sitegpt whoami before making changes.
  • Restrict tokens to specific chatbots when the agent only needs one chatbot.
  • Confirm before destructive commands such as delete, revoke, remove, or bulk cleanup.
  • Rotate or revoke tokens after demos, shared sessions, or experiments.
  • Do not paste raw SiteGPT API tokens into chats unless you fully trust the environment.

​
Troubleshooting

ProblemWhat to ask the agent to check
Agent uses the wrong accountRun sitegpt profiles list and sitegpt --profile <name> whoami.
Agent cannot access a chatbotCheck whether the token is chatbot-restricted and includes the required scopes.
Command output is hard to parseAdd --json to the command.
Agent cannot find a commandRun contextual help, such as sitegpt knowledge --help or sitegpt settings --help.
Production vs local confusionCheck SITEGPT_API_BASE and the profile API base with sitegpt profiles show <profile>.
For more fixes, see Troubleshooting.