servyx-cli

Deploy local projects to Servyx by rsyncing files over SSH, then triggering the existing Servyx deployment queue and pipeline.

Prerequisites

• Node.js 18+
• rsync and ssh available on your PATH
• Your SSH public key added to the app's system user in the Servyx dashboard
• Network access to the target server on port 22

Install

npm install -g servyx-cli

This installs the latest published version (no version pin needed). To upgrade an existing install:

npm update -g servyx-cli
# or explicitly:
npm install -g servyx-cli@latest

Check your installed version:

servyx --version

From source:

cd servyx-cli && npm install && npm link

Quick start

# 1. Authenticate
servyx login

# 2. Link your project directory to an app
cd my-app
servyx link

# 3. Deploy (server .env and .htaccess are preserved by default)
servyx deploy

# 3b. React/Vite frontends: upload local .env files too
servyx deploy --with-env

# 4. Check recent deployments
servyx status

Configuration

• Global config: ~/.servyx/config.json (mode 600)
• Project config: servyx.json in your project root
• Optional excludes: .servyxignore (rsync patterns). By default, hidden files (.env, .htaccess, etc.) are not uploaded and existing server copies are preserved. Use servyx deploy --with-env to upload local .env / .env.* files (useful for React/Vite builds).

How it works

1. servyx deploy fetches the deploy target (SSH user, host, staging path) from cli-service
2. Files are rsynced to <app_root>/.cli-staging on the server (local hidden files are skipped unless --with-env)
3. Live dotfiles from public are copied into staging so they are not removed on deploy (.env is skipped when using --with-env)
4. cli-service calls server-service to queue a CLI deployment (with_env tells the agent to sync uploaded env files)
5. The agent syncs staging → public, preserving .htaccess and (by default) .env on the server
6. The CLI polls until the deployment succeeds or fails