takeoff-cli v4.1.0

🚀 takeoff is the perfect tool if you want to automate workflows with a command line integration.

Features

• 💁‍ Ultra-Easy™ requiring only two properties (get, exec)
• 🔌 Plug & Play
• 💎 No configuration required
• 🌟 You can install it globaly or project-based
• 🧙‍ One Dependency to rule them all
• 📦 Shipped with a bunch of useful utils
• 🔍 Detects valid stations up the tree
• ⏱ Save time by automating your workflow
• 🕹 Interactive mode
• 💚 Full tested with coverage check
• ⚡️ Battle-tested, its used in several >1000 employee companies

Install

npm

npm install takeoff -g

yarn

yarn global add takeoff -g

npx

npx takeoff

Project based

Sometimes you don't want to install things global, you can also install takeoff only in specific projects

npm install takeoff --save-dev

Add to scripts in package.json:

{
  "scripts": {
    "takeoff": "takeoff"
  }
}

Then use takeoff in the project with:

npm run takeoff

Usage

Simple example which shows how fast you can create a automation

1. Create a file: .takeoff/basic-example.js

module.exports = {
  get: 'firstname',
  exec: ({ firstname }) => {
    console.log(`👋 Hello ${firstname}`);
  }
};

2. Run takeoff in the folder

API

Station

A station is a object which can have the following properties

Full Example

{
  name: 'Get name',
  description: 'Ask for user details',
  get: [
    'Firstname',
    'Lastname',
    () => [
      'Age',
      (f) => new Promise(resolve => {
        console.log(42, f)
        setTimeout(() => {
          resolve(() => 'Gender')
        }, 500)
      })
    ]
  ],
  exec: function() {
    console.log('Hello World!');
  }
}

CLI

Usage: takeoff [options]

Options:
  -V, --version             output the version number
  --stations-folder [path]  Pass a custom path where takeoff should search for stations
  -h, --help                output usage information

Utils

» Checkout the documentation for more details

Contribute

To contribute clone the repo

$ git clone git@github.com:entwicklerstube/takeoff.git

Now you've two ways, either you run the tests:

$ npm test

or you build it and execute takeoff localy

$ npm run build
$ node takeoff.js

Debug

We're using the package debug, so its enough to just set use the env variable DEBUG with an global like:

$ DEBUG=takeoff node takeoff.js