@linusjaderlund/spaceshuttle v0.1.0
🚀 spaceshuttle
About
spaceshuttle is a command-line tool for easy deploy of your code to a server. The tool wraps around ssh2-sftp-client (developed by jyu213 and theophilusx) to create a convenient way to deploy. Originally developed to be used with npx
to easily configure a build and deploy pipeline with npm run
.
Warning
This tool is still under development and may not work. First stable version will soon be available after some testing and adding of more functionality.
Installation
Execute from npm server
npx spaceshuttle
Save and run globally
npm i --g spaceshuttle
Save and run locally (not encouraged)
npm i -D spaceshuttle
Usage
npx spaceshuttle [options]
# option format: <key>=<value>
Example
npx spaceshuttle host=sftp.yourhost.com privateKey=~/.ssh/id_rsa serverPath=www
Note: npx
can be neglected if spaceshuttle is installed globally
Command-line options
Options are formatted <key>=<value>
and can be used in combination separated by space
- host - URL to server
- port - server port
- default: 22
- username - username used to authenticate you
- password - password used to authenticate you
- privateKey - local path to your private key user to authenticate you (recommended)
- passphrase - passphrase used together with private key to authenticated you
- default: empty string (
''
) if private key is specified
- default: empty string (
- localPath - path to directory which you want to deploy
- default: current terminal path
- serverPath - path to directory which you want to deploy to
- default: empty string (
''
), root of server
- default: empty string (
sftp.json options
Same options as for the command line can be set using sftp.json
and should be present in the same directory as your terminal is
pointing when running spaceshuttle
. Note that any options set in the command-line will override sftp.json. Example of such file could look like this:
{
"host": "sftp.yourserver.com",
"port": 4444,
"localPath": "dist",
"serverPath": "www",
"username": "youruser",
"password": "******"
}
4 years ago