Vite-plugin-sftp-deploy NPM

SFTP Vite Deploy

A Vite plugin that allows you to automatically deploy your project to your SFTP server using NodeSSH

Installation

with npm

  npm install vite-plugin-sftp-deploy -D

with pnpm

  pnpm install vite-plugin-sftp-deploy -D

Example

import UploadToSFTP from 'ssh-vite-deploy';

// https://vitejs.dev/config/
export default defineConfig({

  plugins: [
    react(),
    UploadToSFTP({
      host: 'sftp.example.com',
      username: 'test',
      password: 'supersecurepassword',
      port: 22,
      remotePath: 'www',
      localPath: process.cwd() + '/dist',
      verbose: true
    })
  ],
})

Variables

Parameter	Type	Description
`host`	`string`	Required. The SSH server host url
`username`	`string`	Required. The SSH username
`password`	`string`	Required. The SSH password
`remotePath`	`string`	Required. The SSH remote path to put the files
`localPath`	`string`	The local path to grab the files (Default: process.cwd() + 'dist')
`port`	`number`	The SSH server port (Default: 22)
`verbose`	`boolean`	Show all logs (Default: false)

Acknowledgements

NodeSSH

Authors

@abrahampo1

Used By

This project is used by the following companies:

ASoft SL

vite-plugin

cli-progress consola node-ssh npmrc

4 months ago

4 months ago

4 months ago

4 months ago