Skip to content
SiteOS

Documentation

Installation

Install the SiteOS plugin and CLI, sign in with your invited email, and connect a repository to a project.

Last updated

The SiteOS plugin gives your AI agent workflows for setup, implementation and diagnostics. The CLI performs supported account, project and service operations. You can complete CLI sign-in and project creation without opening the SiteOS dashboard; email verification still requires your participation.

Install the agent plugin

Choose the host you use. These commands install the public SiteOS plugin, including its service skills and remote MCP connection.

Codex

Use a Codex version with plugin support:

codex plugin marketplace add https://github.com/pixel-point/siteos.git
codex plugin add siteos@siteos

Start a new Codex session after installation. If your terminal reports that plugin or marketplace is unavailable, update to a Codex version that supports plugins before retrying.

Claude Code

claude plugin marketplace add https://github.com/pixel-point/siteos.git
claude plugin install siteos@siteos

Run /reload-plugins in Claude Code or start a new session.

Other agents

For an agent that supports the Agent Skills format:

npx skills add pixel-point/siteos --all

This installs the skills. Configure remote MCP separately if your host supports it.

Install the CLI

Use Node.js 22 or later. Run this in your terminal:

npm install --global @siteoshq/cli@latest
siteos --version
siteos --help

For a one-off command without a global installation, use npx @siteoshq/cli@latest --help. Run project commands from your repository so the CLI uses the right local selection.

Let the agent guide setup

In Codex:

$siteos Set up SiteOS for this repository. Check my sign-in and help me select
an Organization. Inspect the website, suggest which services are useful,
and help me select or create a Project and choose its environment.

In Claude Code, use the same request after /siteos:siteos.

The agent can start email sign-in, complete it with the one-time token from your verification email, list available organizations, and select a project or create one when you request a new website.

During early access, new accounts join by invitation. Request access if you do not have one, then sign in with the invited email address. Accept the invitation in the browser before working with that Organization from the CLI. See Account and team.

For a new website, the agent creates the project with its public URL. It offers optional Google Analytics, Tag Manager, Google Search Console and GitHub connections, which you can skip. With your approval, it starts a first site audit, competitor research and a small AI-answer sample. The research and AI sample use the Organization's SEO credits; the site audit does not. Google consent and resource sharing happen in the SiteOS browser; GitHub consent opens from a link the agent provides.

You do not need to put organization names, project IDs or credentials in the initial prompt. The agent reads available choices and asks for decisions it cannot infer. It cannot bypass email verification, invitations, team permissions or a provider's authorization screen.

Check the selected context

siteos auth status --json
siteos project status --json
siteos project environment list --json

Confirm the organization, project and environment in project status. That repository's selection can differ from the global organization shown by auth status. See Projects and environments to select an existing target explicitly. After choosing the intended environment, connect the service you need:

siteos project connect search --json

This prepares a Search workspace. Content import and website installation are separate steps covered in Set up Search.

Remote MCP authorization is separate from CLI sign-in. See AI & MCP for that connection, or Account and team if access is missing.