CLI

sylphx is the platform from a terminal: one binary that calls the same API as the SDKs, generated from the same contracts. 29 services, 158 collections and 735 commands are on the pages below, and the porcelain — login, whoami, link — is hand-written on the same SDK. The API reference is the same surface over HTTP, and Agents and coding assistants is the MCP server.

#Install

curl -fsSL https://sylphx.com/install/cli | bash
npm install -g @sylphx/cli
cargo install sylphx-cli --locked

The three channels install the same sylphx binary; pick one and keep to it, so one sylphx is on your PATH. Servers and coding agents use the script.

The reference below follows the current API contracts. Release channels may contain fewer commands: check sylphx --version and sylphx --help for your installed command tree. Published CLI compatibility lists known version differences.

#Update

There is no sylphx update: the binary does not update itself. Update the way you installed it — the same command as Install, run again.

#Sign in

sylphx login prints a short code and waits while you approve the request in the browser; the key is stored in your operating system's keychain. Sign in has the flow in full. On a machine with no browser, sylphx login --api-key - reads a key from standard input instead, and SYLPHX_API_KEY is the key a command uses when none is stored.

#Grammar

sylphx <service> <collection> <verb> [NAME|PARENT] [--flags]

• The service and collection are the tree's own names in kebab-case, so sylphx data databases list is the databases collection of the data service. A collection segment is unique across the platform, so it identifies its service on its own.
• The verb is the method's verb: list, get, create, update, delete, or the verb a service adds of its own (revoke, rotate).
• The positional is the resource's NAME, the parent a List runs in (PARENT), or the ID a Create asks for, which the server assigns when it is left out. A bare id is enough for a name below the linked project (sylphx link).
• The flags are the request's fields in dotted kebab-case: --spec.engine is spec.engine in the body, and an enum flag takes the contract's values. --dry-run is validate_only, and --parent is how a Create names the parent it creates in — every other method takes its parent, or its name, as the positional.

#Global flags

Every generated command takes the two flags the tree declares:

The binary carries four more of its own, on every command:

#Services

Every collection in the generated command contract, and its service. A collection's reference is at its own page; check the installed CLI help before using a service command.

#Service commands

A few calls belong to a service rather than to a collection, and are typed with the service alone:

#Porcelain

These verbs are hand-written on the same SDK rather than generated from the tree: