cli

README

Serverless functions and edge microservices made painless

Installation | Getting Started | Documentation | Contributing | License

Qodeflow is an open source framework to simplify building efficient & modern serverless functions and edge microservices and this is the cli that makes it all happen.

QODEFLOW CLI

The Qodeflow CLI is the primary tool to use when working with a Qodeflow application. It is used to create, modify and build Qodeflow applications

Installation

Prerequisites

To get started with the Qodeflow CLI you'll need to have a few things

• The Go programming language version 1.11 or later should be installed.
• In order to simplify dependency management, we're using go mod. For more information on go mod, visit the Go Modules Wiki.

Install the cli

To install the CLI, simply open a terminal and enter the below command

$ go install github.com/project-qodeflow/cli/...@latest

Build the CLI from source

You can build the cli from source code as well, which is convenient if you're developing new features for it! To do that, follow these easy steps

# Get the flogo CLI from GitHub
$ git clone https://github.com/project-qodeflow/cli.git

# Go to the directory
$ cd cli

# Optionally check out the branch you want to use 
$ git checkout test_branch

# Run the install command
$ go install ./... 

Getting started

Getting started should be easy and fun, and so is getting started with the Qodeflow cli.

First, create a file called qodeflow.json and with the below content (which is a simple app with an HTTP trigger)

{
  "name": "SampleApp",
  "type": "qodeflow:app",
  "version": "0.0.1",
  "appModel": "1.1.0",
  "imports": [
  	"github.com/postqode/qodeflow-contrib/trigger/rest",
  	"github.com/postqode/qodeflow-contrib/activity/log",
    "github.com/postqode/qodeflow-flow"
  ],
  "triggers": [
    {
      "id": "receive_http_message",
      "ref": "#rest",
      "name": "Receive HTTP Message",
      "description": "Simple REST Trigger",
      "settings": {
        "port": 9233
      },
      "handlers": [
        {
          "settings": {
            "method": "GET",
            "path": "/test"
          },
          "action": {
            "ref": "#qodeflow-flow",
            "settings": {
              "flowURI": "res://flow:sample_flow"
            }
          }
        }
      ]
    }
  ],
  "resources": [
    {
      "id": "flow:sample_flow",
      "data": {
        "name": "SampleFlow",
        "tasks": [
          {
            "id": "log_message",
            "name": "Log Message",
            "description": "Simple Log Activity",
            "activity": {
              "ref": "#log",
              "input": {
                "message": "Simple Log",
                "addDetails": "false"
              }
            }
          }
        ]
      }
    }
  ]
}

Based on this file we'll create a new qodeflow app

$ qodeflow create -f qodeflow.json myApp

From the app folder we can build the executable

$ cd myApp
$ qodeflow build -e

Now that there is an executable we can run it!

$ cd bin
$ ./myApp

The above commands will start the REST server and wait for messages to be sent to http://localhost:9233/test. To send a message you can use your browser, or a new terminal window and run

$ curl http://localhost:9233/test

For more tutorials check out the Labs section in our documentation

Documentation

There is documentation also available for CLI Commands and CLI Plugins.

Contributing

Want to contribute to Project Qodeflow? We've made it easy, all you need to do is fork the repository you intend to contribute to, make your changes and create a Pull Request! Once the pull request has been created, you'll be prompted to sign the CLA (Contributor License Agreement) online.

Not sure where to start? No problem, you can browse the Project Qodeflow repos and look for issues tagged kind/help-wanted or good first issue. To make this even easier, we've added the links right here too!

• Project Qodeflow: kind/help-wanted and good first issue
• qodeflow cli: kind/help-wanted and good first issue
• qodeflow core: kind/help-wanted and good first issue
• qodeflow contrib: kind/help-wanted and good first issue

Another great way to contribute to Project Qodeflow is to check flogo-contrib. That repository contains some basic contributions, such as activities, triggers, etc. Perhaps there is something missing? Create a new activity or trigger or fix a bug in an existing activity or trigger.

If you have any questions, feel free to post an issue and tag it as a question, email flogo-oss@tibco.com or chat with the team and community:

• The project-flogo/Lobby Gitter channel should be used for general discussions, start here for all things Qodeflow!
• The project-flogo/developers Gitter channel should be used for developer/contributor focused conversations.

For additional details, refer to the Contribution Guidelines.

License

Qodeflow source code in this repository is under a BSD-style license, refer to LICENSE

Documentation

Index

• func Version() string

Functions

func Version

func Version() string

Version will return the release version