---
# @generated by sylphx-gen. Do not edit.
title: "CLI"
description: "The Sylphx CLI: install, sign in, the command grammar, every service and collection, and the hand-written verbs."
type: reference
product: platform
summary: "One binary for the whole platform, generated from the same contracts as the API."
updated: 2026-09-28
order: 9
---

`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](/docs/api) is the
same surface over HTTP, and [Agents and coding assistants](/docs/agents) is the
MCP server.

## Install

```bash
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](/docs/platform/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](#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](/docs#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

```text
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:

| Flag | Type | What it does |
| --- | --- | --- |
| `--output` | `table\|json\|yaml\|name` | Output format; tables show name, Ready, and age. Default `table`. |
| `--from-file` | `path` | Read the whole request body from a YAML or JSON file. |

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

| Flag | Type | What it does |
| --- | --- | --- |
| `--api-key` | `KEY` | The key to sign the call with; when it is left out, `SYLPHX_API_KEY`, then the key `sylphx login` stored. |
| `--yes` | `bool` | Do not ask before a destructive call. |
| `--no-wait` | `bool` | Return a long-running call at once instead of waiting for it. |
| `--all` | `bool` | A `list` follows every page, not only the first. |

## 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 | Command | Collections |
| --- | --- | --- |
| Sylphx Access | `sylphx access` | [Orgs](/docs/cli/orgs), [Projects](/docs/cli/projects), [Envs](/docs/cli/envs), [Service enablements](/docs/cli/service_enablements), [API keys](/docs/cli/api_keys) |
| Sylphx Agents | `sylphx agents` | [Transfers](/docs/cli/transfers), [Agents](/docs/cli/agents), [Agent versions](/docs/cli/agent_versions), [Agent sessions](/docs/cli/agent_sessions), [Goals](/docs/cli/goals), [Waits](/docs/cli/waits), [Queued executions](/docs/cli/queued_executions), [Session events](/docs/cli/session_events), [Memory stores](/docs/cli/memory_stores), [Memories](/docs/cli/memories), [Owner pools](/docs/cli/owner_pools) |
| Sylphx AI | `sylphx ai` | [AI models](/docs/cli/ai_models) |
| Sylphx Analytics (not available yet) | `sylphx analytics` | [Analytics events](/docs/cli/analytics_events) |
| Sylphx Artifacts | `sylphx artifacts` | [Artifacts](/docs/cli/artifacts) |
| Sylphx Generated Assets | `sylphx assets` | [Assets](/docs/cli/assets) |
| Sylphx Auth | `sylphx auth` | [Auth configs](/docs/cli/auth_configs), [End users](/docs/cli/end_users), [Sessions](/docs/cli/sessions), [Identities](/docs/cli/identities), [Customer organizations](/docs/cli/customer_organizations), [Memberships](/docs/cli/memberships), [Organization roles](/docs/cli/organization_roles), [Trusted issuers](/docs/cli/trusted_issuers), [Invitations](/docs/cli/invitations), [Email domains](/docs/cli/email_domains), [OAUTH clients](/docs/cli/oauth_clients) |
| Sylphx Billing (not available yet) | `sylphx billing` | [Meters](/docs/cli/meters), [Plans](/docs/cli/plans), [Billing accounts](/docs/cli/billing_accounts), [Invoices](/docs/cli/invoices), [Usage reports](/docs/cli/usage_reports), [Budget leases](/docs/cli/budget_leases) |
| Sylphx Broker | `sylphx broker` | [Trust policies](/docs/cli/trust_policies), [Token exchanges](/docs/cli/token_exchanges) |
| Sylphx Build | `sylphx build` | [Builds](/docs/cli/builds), [Build caches](/docs/cli/build_caches) |
| Sylphx Config | `sylphx config` | [Config flags](/docs/cli/config_flags), [Config segments](/docs/cli/config_segments), [Config changes](/docs/cli/config_changes) |
| Sylphx Connections | `sylphx connections` | [Connection providers](/docs/cli/connection_providers), [Connections](/docs/cli/connections) |
| Sylphx Data | `sylphx data` | [Databases](/docs/cli/databases), [KV namespaces](/docs/cli/kv_namespaces), [Buckets](/docs/cli/buckets), [Search indexes](/docs/cli/search_indexes) |
| Sylphx Entitlement (not available yet) | `sylphx entitlement` | [Entitlements](/docs/cli/entitlements) |
| Sylphx Events | `sylphx events` | [Topics](/docs/cli/topics), [Events](/docs/cli/events), [Connectors](/docs/cli/connectors), [Subscriptions](/docs/cli/subscriptions), [Queues](/docs/cli/queues), [Webhook endpoints](/docs/cli/webhook_endpoints), [Webhook deliveries](/docs/cli/webhook_deliveries), [Inbound endpoints](/docs/cli/inbound_endpoints), [Realtime channels](/docs/cli/realtime_channels), [Realtime messages](/docs/cli/realtime_messages), [Realtime members](/docs/cli/realtime_members) |
| Sylphx Hosting | `sylphx hosting` | [Uptime manifests](/docs/cli/uptime_manifests), [Serving routes](/docs/cli/serving_routes), [Service observations](/docs/cli/service_observations), [Services](/docs/cli/services), [Service rollouts](/docs/cli/service_rollouts), [Previews](/docs/cli/previews), [Source links](/docs/cli/source_links) |
| Sylphx Keys | `sylphx keys` | [Keys](/docs/cli/keys), [Key versions](/docs/cli/key_versions) |
| Sylphx Knowledge | `sylphx knowledge` | [Spaces](/docs/cli/spaces), [Knowledge schemas](/docs/cli/knowledge_schemas), [Episodes](/docs/cli/episodes), [Entities](/docs/cli/entities), [Relations](/docs/cli/relations) |
| Sylphx Localization | `sylphx localization` | [Catalogs](/docs/cli/catalogs), [Entries](/docs/cli/entries), [Glossaries](/docs/cli/glossaries) |
| Sylphx Money | `sylphx money` | [Processor events](/docs/cli/processor_events), [Merchant accounts](/docs/cli/merchant_accounts), [Price catalogs](/docs/cli/price_catalogs), [Checkout policies](/docs/cli/checkout_policies), [Store connections](/docs/cli/store_connections), [Store purchases](/docs/cli/store_purchases), [Customer subscriptions](/docs/cli/customer_subscriptions), [Entitlement grants](/docs/cli/entitlement_grants), [Checkout sessions](/docs/cli/checkout_sessions), [Tax threshold statuses](/docs/cli/tax_threshold_statuses), [Portal sessions](/docs/cli/portal_sessions), [Licence keys](/docs/cli/licence_keys), [Licence tokens](/docs/cli/licence_tokens), [Usage settings](/docs/cli/usage_settings), [Usage tiers](/docs/cli/usage_tiers), [Usage reservations](/docs/cli/usage_reservations), [Usage events](/docs/cli/usage_events), [Credit grants](/docs/cli/credit_grants), [Usage invoices](/docs/cli/usage_invoices), [Usage meters](/docs/cli/usage_meters), [Usage meter prices](/docs/cli/usage_meter_prices), [Revenue sources](/docs/cli/revenue_sources), [Revenue](/docs/cli/revenue), [Revenue facts](/docs/cli/revenue_facts), [Exchange rates](/docs/cli/exchange_rates) |
| Sylphx Network (not available yet) | `sylphx network` | [Domains](/docs/cli/domains), [Certificates](/docs/cli/certificates), [Routes](/docs/cli/routes), [Egress identities](/docs/cli/egress_identities), [Private links](/docs/cli/private_links) |
| Sylphx Notify | `sylphx notify` | [Phone numbers](/docs/cli/phone_numbers), [Mail domains](/docs/cli/mail_domains), [Mail routes](/docs/cli/mail_routes), [Senders](/docs/cli/senders), [Recipients](/docs/cli/recipients), [Preferences](/docs/cli/preferences), [Message topics](/docs/cli/message_topics), [Suppressions](/docs/cli/suppressions), [Templates](/docs/cli/templates), [Messages](/docs/cli/messages), [Mailboxes](/docs/cli/mailboxes), [Mailbox OAUTH apps](/docs/cli/mailbox_oauth_apps), [Mailbox connect links](/docs/cli/mailbox_connect_links), [Inbound emails](/docs/cli/inbound_emails), [Inbox items](/docs/cli/inbox_items), [Broadcasts](/docs/cli/broadcasts), [Sms numbers](/docs/cli/sms_numbers), [Inbound sms](/docs/cli/inbound_sms) |
| Sylphx Observability | `sylphx observability` | [Uptime sources](/docs/cli/uptime_sources), [Uptime checks](/docs/cli/uptime_checks), [Log entries](/docs/cli/log_entries), [Traces](/docs/cli/traces), [Generations](/docs/cli/generations), [Error groups](/docs/cli/error_groups), [Error events](/docs/cli/error_events), [Source maps](/docs/cli/source_maps), [Scrubbing policies](/docs/cli/scrubbing_policies) |
| Sylphx Realtime (not available yet) | `sylphx realtime` | — |
| Sylphx Release | `sylphx release` | [Releases](/docs/cli/releases), [Rollouts](/docs/cli/rollouts) |
| Sylphx Runners (not available yet) | `sylphx runners` | [Scale sets](/docs/cli/scale_sets), [Runners](/docs/cli/runners) |
| Sylphx Sandboxes | `sylphx sandboxes` | [Sandbox shapes](/docs/cli/sandbox_shapes), [Pools](/docs/cli/pools), [Leases](/docs/cli/leases), [Lease events](/docs/cli/lease_events), [Volumes](/docs/cli/volumes), [Snapshots](/docs/cli/snapshots) |
| Sylphx Secrets | `sylphx secrets` | [Secrets](/docs/cli/secrets), [Secret versions](/docs/cli/secret_versions), [Secret bindings](/docs/cli/secret_bindings), [Profiles](/docs/cli/profiles), [Profile versions](/docs/cli/profile_versions) |
| Sylphx Workflows | `sylphx workflows` | [Workflows](/docs/cli/workflows), [Schedules](/docs/cli/schedules), [Runs](/docs/cli/runs), [Jobs](/docs/cli/jobs), [Job runs](/docs/cli/job_runs), [Distributed jobs](/docs/cli/distributed_jobs), [Distributed runs](/docs/cli/distributed_runs) |

## Service commands

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

| Command | Method | What it does |
| --- | --- | --- |
| `sylphx access whoami` | [`access.whoami`](/docs/api/access/whoami) | Returns the caller: the principal and the scope of the key or token that authenticated this request. Clients fill their org, project, and env defaults from it; every valid key may call it, whatever its scopes. |

## Porcelain

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

| Command | What it does |
| --- | --- |
| `sylphx login` | Sign in: a browser approval (device flow), or an Access key with `--api-key KEY\|-` |
| `sylphx logout` | Revoke the stored key and forget it |
| `sylphx whoami` | Show the caller: principal, org, project, env, scopes |
| `sylphx link` | Link this directory to an org, project and env (`.sylphx/project.json`); `init` is the same command |
| `sylphx api` | Call any path of the API directly (raw escape hatch): `sylphx api GET /v1/whoami` |
| `sylphx mcp` | Run the [Sylphx MCP server](/docs/agents) over stdio |
| `sylphx completion` | Print a shell completion script: `sylphx completion bash` |