npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dist-to-sftp

v0.1.16

Published

This package is used to upload a dist folder to a ftp server.

Downloads

4

Readme

dist-to-sftp

dist-to-ftp is a simple command-line tool that enables you to connect to an SFTP server.

This straightforward tool simplifies the process of deploying your website or data to the desired location on the SFTP server.

Basic Usage:

  • Start by setting up your FTP credentials in .env file - this can be skipped, see the options.
  • Delete and upload all files to remote path folder.

Beware! the script will indeed remove all existing files and directories on the server remote path. See options to keep them.

Installation

To install dist-to-sftp, you can use npm or yarn:

# Using npm
npm install --save-dev dist-to-sftp
# Using yarn
yarn add -D dist-to-sftp

Usage

Once installed, you can run the tool using the following command:

dist-to-sftp

Setting up env files is just filling up these environment variables. It will check for the presence of a .env file and of these variables inside.

SFTP_HOST=
SFTP_USERNAME=
SFTP_PASSWORD=
SFTP_PATH=

Options

The following options can be passed as command-line arguments:

-h, --help: Shows the help message.
-s, --skip: Skips the .env file setup.
-k, --keep: Doesn't delete files on the remote server (default: true).
-r, --remote: Specifies the remote path (requires a value).
-d, --dist: Specifies the local dist path (requires a value).
--host: Specifies the SFTP host (requires a value).
-u, --username: Specifies the SFTP username (requires a value).
-p, --password: Specifies the SFTP password (requires a value).
-f, --files: pass multiple paths - in addition to the dist folder

Example

# Basic usage
dist-to-sftp -k

# A more advance usage
dist-to-sftp -r /www/my_website/ -d ./my_dirst_folder --host ftp.fake.hosting.domain.net -u my_username -p my_password

dist-to-sftp -f ./.htaccess

Dependencies

The dist-to-ftp tool has the following dependencies:

  • dotenv - version 16.1.4
  • ssh2 - version 1.13.0

These dependencies will be automatically installed when you install dist-to-ftp.

License

This package is licensed under the ISC License.