Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Configuration

Configure Cloud credentials for the hosting contract. Identity, Data, and AI keep their own credentials.

Secret key
sk_{env}_{64hex}
Publishable key
pk_{env}_{32hex}
Service token
svc_…

Before you start

Sign in and create a project

Step 1. Sign in

Open Sign in. Cloud uses Sylphx Auth for Google login. This is not a second identity system.

Step 2. Create a Project

In the Cloud Console, create a Project and an Environment.

Step 3. Cloud credentials

Copy Cloud credentials from Project → API Keys. They admit Cloud APIs only.

PropertyTypeDescription
Secret Keysk_{env}_{64hex}Server-side Cloud API access. Never expose to the browser.
Publishable Keypk_{env}_{32hex}Client-safe Cloud credential for public Cloud config.

Which credential goes where

PropertyTypeDescription
SYLPHX_TOKENrequiredsvc_…Machine credential for the CLI and CI. Reads/writes the org and project it was issued for.
SYLPHX_URLsylphx://sk_prod_…@<slug>.api.sylphx.comServer-side connection for services deployed on Cloud.
NEXT_PUBLIC_SYLPHX_URLsylphx://pk_prod_…@<slug>.api.sylphx.comClient-safe connection string. Publishable keys only.

Key handling

sk_… keys are secrets: keep them in the environment of the service that needs them, never in a repository, and never in a browser bundle. Publishable pk_… keys are the only Cloud credentials that belong on the client.

CLI context

Deploying uses the Sylphx CLI, not a login/database/AI SDK:

Link this checkout to a projectbash
sylphx login
sylphx orgs list
sylphx projects list
sylphx link --project proj_… --org-id org_…
sylphx status

CI / service tokens

export SYLPHX_TOKEN=svc_… — no interactive login. Prefer sylphx … --json for agents.

Environment variables

.env.localbash
# Cloud operator token for CLI / CI — never expose to the browser
SYLPHX_TOKEN=svc_…

# Optional: pin org/project after sylphx link
# (written by the CLI into sylphx.toml)

Independent products

Identity, Data, and AI issue their own credentials on those sites. Cloud credentials do not admit those APIs.

Verify

bash
sylphx whoami            # the account the CLI will act as
sylphx doctor            # local install, auth and config health
sylphx status            # org/project/service the current directory is linked to
Run from the project root so sylphx.toml is picked up.

Next steps