Skip to content

sky onboarding

sky onboarding is an interactive wizard for choosing a SkyState project and getting a stack-specific starter path.

Synopsis

bash
sky onboarding

What It Does

sky onboarding is TTY-only. It:

  1. Signs you in if needed, or reuses the stored account session.
  2. Shows your projects and lets you pick one, or create a new project inline if you have none.
  3. Asks where SkyState will run first.
  4. For Node.js and curl examples, asks whether to use an existing project API key or create a new one for the selected project.
  5. Prints a stack-specific starter snippet and exits.

It does not write .env.local, touch .gitignore, or edit your application files. For browser SDK examples, it may inspect common local project files to suggest a callback URL. For Node.js and curl examples, it creates a project API key only if you choose that option.

Output Tracks

  • React and Vanilla JS get both public and user-state guidance.
  • Node.js and curl get public-state HTTP examples. Write requests in those examples need a project API key.

If you choose Use existing project API key, snippets use <your-api-key>. Set SKYSTATE_API_KEY or keep a key in .env.local before running them.

If you choose Create new project API key, sky onboarding creates a project-scoped key and inserts it into the snippet. The key is shown once. If key creation hits your quota, onboarding continues with <your-api-key> and shows commands for listing and revoking existing keys.

  • Use sky examples any time you want the same snippets without going through onboarding.
  • Use sky project keys to create, list, or revoke project API keys.

Errors

SituationExit CodeMessage
Non-interactive terminal1sky onboarding requires an interactive terminal.

Notes

  • sky onboarding uses your selected project and account in snippets.
  • The command is the right place to explore SkyState, not to write local project files.