Wondering what‚Äôs next for npm?Check out our public roadmap! ¬Ľ

    fh-deploy

    1.3.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    Deploy files to a server via SFTP. Built as an addition to Vuepress.

    Note! Running fh-deploy will automatically overwrite any files of the same name on your server WITHOUT prompting. Assume your files are going to be overwritten as soon as you run fh-deploy!

    Usage

    Automatic:

    # Local installation 
    npm i fh-deploy --save
     
    # Global installation 
    npm i -g fh-deploy
     
    fh-deploy # automatically creates a config file with user input 

    Manual:

    const deploy = require('fh-deploy')
     
    // either:
    deploy({
        settings: {
            host: 'your sftp host',
            port: 'your port',
            username: 'username',
            password: 'password' // optional - if blank, you'll be asked for your password on each deploy
        },
        // If this queue is empty or null, fh-deploy will deploy the files in package.json's "files" array
        queue: [
            'filename.js',
            'all-files-one-level-deep/*.*',
            'all-files-in-all-subdirectories/**/*.*'
        ],
        target: '/absolute/path/to/deploy/target',
     
        // optional properties below
        lazy: true // if `true`, do not replace a file if it has not been modified since the last upload
    })
     
    // or a path to a JSON file with the above configuration:
    deploy('./path-to-config-file')
     
    // config can also be a single array called "environments" with different settings:
    deploy({
        environments: [
            {
                name: 'staging',
                settings: {
                    host: 'your staging host',
                    port: 'your port',
                    username: 'username',
                    password: 'password' // optional - if blank, you'll be asked for your password on each deploy
                },
                queue: [
                    'filename.js',
                    'all-files-one-level-deep/*.*',
                    'all-files-in-all-subdirectories/**/*.*'
                ],
                target: '/absolute/path/to/deploy/target',
                lazy: true
            },
            {
                name: 'production',
                settings: {
                    host: 'your production host',
                    port: 'your port',
                    username: 'username',
                    password: 'password' // optional - if blank, you'll be asked for your password on each deploy
                },
                queue: [
                    'filename.js',
                    'all-files-one-level-deep/*.*',
                    'all-files-in-all-subdirectories/**/*.*'
                ],
                target: '/absolute/path/to/deploy/target',
                lazy: true
            }
     
            /* ...etc... */
        ]
    })

    Upload a queue of files to the specified server via SFTP. Uses glob to find files to upload.

    If more than one environment is specified, you can run:

    fh-deploy your-environment-name

    to use the configuration for one of the given environments. If the configuration isn't found, fh-deploy will exit early.


    fh-deploy

    http://funkhaus.us

    Keywords

    none

    Install

    npm i fh-deploy

    DownloadsWeekly Downloads

    7

    Version

    1.3.0

    License

    ISC

    Unpacked Size

    14.5 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar