Skip to content

Getting Started

Everything you need to go from zero to a working SkyState integration.


In This Section

  • Quickstart — the fastest path to your first config push and SDK read
  • Installation — detailed install instructions for the CLI, SDKs, and dashboard
  • Core Concepts — understand accounts, projects, environments, configs, and semantic versioning before you build

Prerequisites

  • A GitHub account (SkyState authenticates via GitHub OAuth)
  • Node.js 18 or later (for the CLI and JavaScript SDKs)
  • A terminal

What Happens in Setup

  1. Sign up — visit https://app.skystate.io and sign in with GitHub. SkyState creates your account and a personal account slug.
  2. Install the CLI — one npm install -g command.
  3. Authenticateskystate login opens your browser and stores a token locally.
  4. Initialize your projectskystate init links a local repository to a SkyState project and writes a dev API key to .env.
  5. Push a configskystate push config.json --env development publishes your first versioned config.
  6. Read it in your app — install @skystate/react or @skystate/core and call useProjectConfig or getConfig.

If you want to skip the background reading and go straight to code, start with the Quickstart.

Built with VitePress