Skip to main content

​
Install

Install the CLI globally from npm:
Verify the installed version:
Upgrade later with:

​
Log in with browser approval

For most users, use the default device login:
The CLI uses SiteGPT’s OAuth device flow with client_id=sitegpt-cli. It will:
  1. Request standard CLI access from SiteGPT.
  2. Print a verification URL and short code.
  3. Open or ask you to open the SiteGPT approval page.
  4. Wait while you approve access in the browser.
  5. Store the approved token in a local profile.
After login, verify the active account:

​
Login options

Reference: global options and login command details. For protocol-level details, see OAuth device flow.
Use either --full-access or repeated --scope values, not both. Device-login options cannot be used together with --token.

​
Standard, full, and custom access

When you run sitegpt login without --scope or --full-access, SiteGPT requests standard CLI access. Standard access includes customer-facing read/write permissions for common CLI operations, but excludes sensitive persistence/admin scopes such as tokens:write, billing:write, and integration management. Use full access only when the CLI or agent needs broad account management:
Use custom scopes for specialized workflows:

​
Manual login with a dashboard-created token

If you do not want to use browser device login from the terminal, you can create a token manually in the SiteGPT dashboard and then save it into the CLI.
1

Open the Agents page

In the SiteGPT dashboard, open Agents.
2

Create an API token

Click Create token, choose the access level or custom permissions, optionally restrict it to specific chatbots, and create the token.
3

Copy the token immediately

SiteGPT shows the plaintext token only once. Copy it before closing the token modal.
4

Save the token in the CLI

5

Verify the profile

To save the token under a named profile:
For production, the default API base is https://sitegpt.ai. If you need to be explicit:
SiteGPT CLI/API tokens look like this:
Treat tokens as opaque credentials and avoid validating one exact shape in scripts. If you are setting this up for a personal AI assistant, see Use with AI agents for the recommended profile and instruction setup.

​
Where profiles are stored

The CLI stores local profiles at:
This file is local to your machine. Do not commit it to source control.

​
Logout

Remove the selected local profile token:
Logging out deletes the local token profile. It does not revoke the token in SiteGPT. Use sitegpt tokens revoke <token-id> or the Agents page to revoke server-side access.