SkyState Documentation

SkyState gives apps durable, versioned JSON state without building state infrastructure. Use public state for application config, feature flags, settings, and catalog or inventory data; use user state for signed-in preferences or app data scoped to one identity.

Start Here

• Quickstart - create a project, push state, and read it from an app
• Installation - CLI, SDKs, and console access
• Core Concepts - accounts, projects, environments, public state, user state, and versions

Product Surfaces

CLI Reference

Use sky to log in, manage projects, push/patch/remove public state, diff and promote environments, inspect user state, manage project API keys, configure hosted auth, and check status.

SDK

Use @skystate/core for framework-agnostic JavaScript/TypeScript clients and @skystate/react for React provider and hooks.

Console

Use the web console to edit public state, inspect user state, manage projects and API keys, configure hosted auth, and view billing/usage.

API Reference

Review the current HTTP route groups, auth schemes, public-state endpoints, account/project routes, billing routes, and auth exchange surface.

Billing

Review Free, Hobby, and Pro limits, monthly request metering, Stored Users limits, and billing management.

Tutorials

The React tutorial builds an app feature by feature; the vanilla and API tracks cover the same app but are still drafts. Pick one from the tutorials overview.

• React (@skystate/react): Build a React app with SkyState.
• Vanilla (@skystate/core): Build a vanilla app with SkyState (draft).
• API: Build with the API (draft).
• Shared finale: Ship public state to production.

Guides

• Troubleshooting - common setup, auth, SDK, and state issues

Key URLs

Resource	URL
Console	https://console.skystate.io
API	https://api.skystate.io
Interactive API reference (Scalar)	https://console.skystate.io/api/scalar/v1
npm CLI package	skystate
npm core SDK package	@skystate/core
npm React SDK package	@skystate/react