Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jerkeeler/rcktship
A lightweight JS library that runs an arbitrary series of shell commands on both local and remote hosts.
https://github.com/jerkeeler/rcktship
Last synced: 2 months ago
JSON representation
A lightweight JS library that runs an arbitrary series of shell commands on both local and remote hosts.
- Host: GitHub
- URL: https://github.com/jerkeeler/rcktship
- Owner: jerkeeler
- License: isc
- Created: 2017-11-04T13:34:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-15T21:20:24.000Z (over 4 years ago)
- Last Synced: 2024-11-16T20:05:44.530Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 281 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rcktship 🚀
[](https://www.npmjs.com/package/rcktship) [](https://www.npmjs.com/package/rcktship) [](https://travis-ci.org/jerkeeler/rcktship) [](https://coveralls.io/github/jerkeeler/rcktship?branch=master) [](https://www.npmjs.com/package/rcktship)
Rcktship is a lightweight [node.js](https://nodejs.org/) library used for easily running a series of commands on both your local machine and remote hosts. This is an ideal library for small scale deployments.
Rcktship is heavily inspired by [Fabric](http://www.fabfile.org/), which is also a remote command runner written in Python.
## Usage
```bash
# Install rcktship CLI globally
$ npm install -g rcktship
# or
$ yarn global add rcktship
# or in your project
$ npm install --save-dev rcktship
# or
$ yarn add -D rcktship
# Launch your first rocketship!
$ rocket [mission] [options]
# or locally
$ ./node_modules/.bin/rocket [mission] [options]
```
Rcktship will look for a top level `rcktship.js` file in your project, but you can explicitly define a config file by passing in --config
The rocket **target** is the host, or list of hosts, that you wish to run the mission on. Targets are defined in your rcktship.js file.
A **mission** is analogous to a Fabric task, which is a predefined set of commands you wish to run.
You **must** provide a target for your rocket, but you do not have to provide a mission. If you do not provide a mission rcktship will look for a **default** mission.
## Sample `rcktship.js` file
```javascript
const rocket = require('rcktship');
rocket.target('prod', [{
"host": "[email protected]",
"port": 22,
"username": "foobar",
"privateKey": "/Users/foobar",
"passphrase": "*****"
}]);
rocket.mission('default', async () => {
console.log('Default mission!');
await rocket.remote('hostname');
});
rocket.mission('pwd', async () => {
await rocket.local('pwd');
await rocket.remote('pwd');
});
```
To run the above missions:
```bash
# Run default task
$ rocket prod
# Run pwd task
$ rocket prod pwd
```
Connection objects used for targets are ConnectConfig from [SSH2](https://github.com/mscdex/ssh2). Look there for any documentation on connection configurations.
## Development
```bash
git clone [email protected]:jerkeeler/rcktship.git
yarn install
yarn start
```
Make any code changes, add tests, manually test your changes, then submit a pull request.
## Testing
```bash
yarn test
```
Rcktship uses [jest](https://facebook.github.io/jest/) to do all testing and test coverage. Along with [ts-jest](https://github.com/kulshekhar/ts-jest) for the TypeScript support.