@sylphx/cli

The official CLI tool for the Sylphx Platform. Deploy, manage logs, environment variables, domains, and more — directly from your terminal.

📖 Full documentation: sylphx.com/docs/cli

Installation

npm install -g @sylphx/cli
# or
bun add -g @sylphx/cli

Quick Start

# Authenticate
sylphx login

# Link your project to a Sylphx app
cd my-project
sylphx link

# Deploy!
sylphx deploy

Commands

Authentication

sylphx login                    # Opens browser for OAuth flow
sylphx login --token <TOKEN>    # Direct token auth (CI/CD)
sylphx logout                   # Clear stored credentials
sylphx whoami                   # Show current user + org + app

Project Management

sylphx link                     # Link current directory to a Sylphx app
sylphx status                   # Show deployment status
sylphx open                     # Open app in browser

Deployments

sylphx deploy                         # Deploy to default environment
sylphx deploy --env staging           # Deploy to staging
sylphx rollback                       # Rollback to previous deployment
sylphx rollback --env production      # Rollback production

Logs

sylphx logs                           # Show recent logs
sylphx logs -f                        # Follow logs (stream continuously)
sylphx logs --env staging             # Logs for staging environment

Environment Variables

sylphx env list                       # List all env vars
sylphx env list --env staging         # List staging env vars
sylphx env set DATABASE_URL=postgres://...
sylphx env set PORT=3000 --env staging
sylphx env rm DATABASE_URL            # Remove an env var

Domains

sylphx domains list                   # List custom domains
sylphx domains add example.com        # Add a domain
sylphx domains rm example.com         # Remove a domain

Configuration

Config is stored in ~/.sylphx/config.json:

{
  "token": "slx_cli_...",
  "defaultOrg": "my-org",
  "apps": {
    "/path/to/project": {
      "appId": "app-uuid",
      "orgId": "org-slug",
      "defaultEnv": "production"
    }
  }
}

CI/CD Usage

For automated environments, use a pre-generated token:

sylphx login --token $SYLPHX_API_TOKEN
sylphx deploy --env production

Or set the env var:

SYLPHX_API_TOKEN=slx_cli_... sylphx deploy

Environment Variables

| Variable | Description | |---|---| | SYLPHX_API_URL | Override API base URL (default: https://sylphx.com) |

Development

bun install
bun run dev -- --help     # Run CLI in dev mode
bun run build             # Build for production

License

MIT © Sylphx