SiteOS CLI

@s-os/cli provides the public siteos command.

Health Check

Run the current health check:

siteos health-check --json

The command prints local readiness diagnostics as JSON. It checks local SiteOS project metadata, project API key presence, config home resolution, organization config presence, and resolved API base URL. API-backed server reachability and authorization checks are outside the local health-check diagnostics.

Local Configuration

The CLI uses SiteOS-native local configuration:

• .siteos/project.json for project and organization identity.
• SITEOS_PROJECT_API_KEY or the connected project's local .env for the project API key.
• SITEOS_API_BASE_URL for API base overrides, defaulting to https://siteos.xui.se.
• SITEOS_HOME for the CLI home, defaulting to ~/.siteos.
• config.json under the resolved CLI home for organization auth profiles.

Raw tokens and project API keys are not printed in normal command output.

Organization Commands

siteos org --help

Organization auth and project commands are exposed in help output. Their API-backed behavior uses the resolved SiteOS API base URL and local organization profiles.

Search Commands

siteos search --help

Search environment and job commands are exposed in help output. Their API-backed behavior uses local project config and project API key resolution.

Forms Commands

siteos forms --help
siteos forms definition check --manifest .siteos/forms/manifest.json
siteos forms definition sync --manifest .siteos/forms/manifest.json

A version 1 manifest contains definition paths relative to the manifest file:

{
  "version": 1,
  "forms": ["contact.definition.json", "demo-request.definition.json"]
}

definition check validates every definition locally, requires complete field metadata and exactly one required primary display field, and rejects schema/field metadata drift or duplicate field keys. It does not require SiteOS credentials. definition sync validates the same manifest before syncing each definition through the project API connection. Removing a path from the manifest does not delete its remote form or historical submissions.

Successful definition sync and submission smoke-test output includes a permanent, optional SiteOS UI URL when organization and project slugs are available. JSON output exposes the same safe URL under ui.url; it never contains a login credential.

Open The SiteOS UI Signed In

siteos ui open forms --form-id <form-id>
siteos ui open search --index-id <index-id>

The command uses the local user-bound organization profile to request a short-lived, single-use browser handoff. It opens the browser directly and does not print the credential-bearing handoff URL. Opening the UI is optional; all managed data remains available through the CLI/API workflows.