Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Compute & delivery2 min

Installation

Install the Sylphx CLI. Quick start ends with a hosted Service, not an all-in-one backend SDK.

Binary
sylphx
Channels
curl · npm · pnpm · bun · cargo · brew
Package
@sylphx/cli

Before you start

  • A terminal on macOS or Linux (the CLI is a native Rust binary)
  • A Sylphx account
  • One install channel — the upgrade path follows the channel you pick

Sylphx CLI deploys hosting

The operator CLI (sylphx, npm @sylphx/cli) deploys Project, Environment, and Service. Auth, data, and models are independent products with their own sites. See Install the CLI.

Install the Sylphx CLI

Pick one channel. Same sylphx binary everywhere:

typescript
curl -fsSL https://sylphx.com/install/cli | bash
export PATH="$HOME/.local/bin:$PATH"
sylphx --version

After install

bash
sylphx doctor
sylphx login
sylphx projects list

Quickstart walkthrough: Sign in, create a project, deploy.

Verify

sylphx --version reports the product version, sylphx doctor reports install, auth and config health, and sylphx projects list proves the CLI can reach your account.

Independent products

Identity, Data, Commerce, Events, Observability, Compute, and AI are not Cloud SKUs. Their docs and credentials live on those product sites. Do not treat leftover @sylphx/apps entry points as the Cloud deploy path.

Next steps