@builtioflow/connector-builder

Built.io Flow CLI

Flow-CLI

Flow command line interface to create connectors and publish to flow platform

To use this cli clone this Project and run below command.

Run

npm install @builtioflow/cli -g // use sudo for linux

Contents

• Get Started
• Commands
• Creating a Local App

Get Started

Flow-CLI is a Command Line Interface tool for Built.io Flow. It lets you build your own applications for Built.io flow. Using Flow-CLI you can deploy your application to Built.io and share your application with others.

Commands

Following are the commands which Flow-CLI supports.

• flow connectors
• flow auth
• flow create
• flow deploy
• flow download
• flow help
• flow history
• flow init
• flow login
• flow logout
• flow set
• flow share
• flow unshare
• flow versions

apps

Use this command to display all the apps by current user.

  flow connectors

Sample Output:

| App Name  |      Version    |      created_at          |
|---------- |-----------------| -------------------------|
| Github    |   1.0           | 2017-06-19T14:22:23.485Z |
| Facebook  |   2.0           | 2017-06-20T11:11:24.485Z |
| Gmail     |   2.0           | 2017-06-23T10:03:22.485Z |

auth

Use this command to create an authentication scaffolding in the app.

  flow auth

create

Use this command to create a scaffolding for trigger, action, lookup.

  flow create trigger example  

deploy

Use this command for building and deploying the application on Built.io Flow.

  flow deploy

download

Use this command for download a .zip file of your app.

  flow download

help

Use this command to list all the commands you can use.

  flow help

Sample Output:

|  Command   |    Example                           |                      Info                                 |
|----------  |--------------------------------------|-----------------------------------------------------------|                                                 
| connectors |   flow connectors                    | Displays all the connectors of the current user           |
| auth       |   flow auth                          | Creates an authentication scaffolding in the app          |
| create     |   flow create trigger trigger_name   | Creates a scaffolding for trigger, action, lookup         |
| deploy     |   flow deploy                        | Builds and deploys app to Built.io Flow                   |
| download   |   flow download                      | Downloads .zip of your application                        |
| help       |   flow help                          | Lists all the commands you can use                        |
| history    |   flow history                       | Shows the complete history of your current application    |
| init       |   flow init example                  | Initializes a new flow app in your directory              |
| login      |   flow login                         | Configures your deploy key and logs you in Built.io Flow  |
| logout     |   flow logout                        | Deletes your access token from your home directory        |
| share      |   flow share                         | Shares your application with other users                  |
| unshare    |   flow unshare                       | Unshares your application from a user                     |
| versions   |   flow versions                      | Displays all the versions of your current application     |

history

Use this command to view the complete history of your current application.

  flow history

Sample Output:

|     User       |      Operation          | Message                |  Date & Time                |
|----------------|-------------------------|------------------------|-----------------------------|
| [e-mail]  | Created trigger         | Name: Received email   | 2017-06-23T08:51:56.815Z    |
| [e-mail]  | Created action          | Name: Save draft       | 2017-06-23T09:10:22.248Z    |
| [e-mail]  | Deployed application    | Version: 1             | 2017-06-23T09:10:30.702Z    |

init

Use this command to create an initial project.

  flow init [path] [foldername] --template=minimal
  flow init example 

• Options
  • template - Optional template argument. Default minimal

login

Use this command for configuring your deploy key and logging into Built.io Flow

  flow login

logout

Use this command for deleting access token from your home directory.

  flow logout

set

Use this command for linking a lookup to action or trigger field

  flow set lookup_name action_name.field_name
  ## example if i want to link repo_list lookup to RepoName field in action get_repo_details
  flow set repo_list repo_details.RepoName 

share

Use this command for sharing your application with other users.

  flow share

unshare

Use this command for unsharing your application from a user.

  flow unshare

versions

Use this command for displaying all the versions and their status of the current app.

  flow versions

Sample Output:

| App name  |   Version     |  Status   |
|---------- |:------------: |-----------|
| Github    |      1        | Published |
|           |      2        | Pending   |
-----------------------------------------

import

To import all swagger api calls as an action in connector.

  flow import <swagger file path>