deloyn

SSH Publish & Deploy CLI

deloyn is a simple command-line tool to publish and deploy your project via SSH and SFTP under Node.

Features

• Interactive confirmation before deployment
• Configurable via publisher.config.js or publisher.config.ts
• Exclude files and directories
• Adjustable batch size for uploads
• Spinner feedback for progress
• TypeScript support with ESM

Installation

Install globally:

npm install -g deloyn

Or use npx:

npx deloyn push

Usage

deloyn push

Available commands:

• push Start publishing (requires config file)
• help Show help message

Configuration

Create a deloyn.config.js or deloyn.config.ts in your project root:

// deloyn.config.ts
import { defineConfig } from 'deloyn';

export default defineConfig({
  serverIp: '1.2.3.4',        // Remote server IP
  username: 'ubuntu',         // SSH username
  remotePath: '/var/www/app', // Path on remote server
  sshKey: '~/.ssh/id_rsa',    // SSH private key path
  excluded: [                 // Files or directories to exclude
    '.git',
    'node_modules',
    'dist',
    'README.md',
  ],
  batchSize: 5,               // Concurrent uploads per batch
  localPath: process.cwd(),   // Local root path to upload
});

License

MIT © xjectro