Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Published CLI compatibility

Match command examples to your installed CLI version.

Check your installed version before copying a command from the generated reference:

Shell
sylphx --version
sylphx --help
sylphx login --help

The reference follows the current API contracts. A published binary can expose fewer commands; the installed binary's --help is the command list for that version.

#CLI 0.25.2

The public npm package and standalone installer distribute 0.25.2 as checked on October 30, 2026. This version supports sylphx login --api-key - and --with-token for reading an Access key from standard input. It does not accept --store-file. On machines without a keychain, set SYLPHX_API_KEY in the process environment and call the API directly:

Shell
SYLPHX_API_KEY=sylphx_sk_… sylphx access whoami

Replace the placeholder with your own Access key through your shell or CI's secret configuration. Keep secret keys out of source code and browser code.

The generated service reference includes command trees that this release does not provide:

ServiceCommand absent from 0.25.2
Agentssylphx agents
Analyticssylphx analytics
Generated Assetssylphx assets
Knowledgesylphx knowledge
Localizationsylphx localization
Realtimesylphx realtime

A service's presence in the reference does not add it to an installed binary. Check its help after updating; use only the commands that version lists.

#Check your sign-in

Shell
sylphx access whoami

This reads the authenticated caller. Run sylphx login first, or provide SYLPHX_API_KEY. Project creation also requires sign-in; it does not create an anonymous project in this release.