Skip to content

Latest commit

 

History

History
78 lines (66 loc) · 2.41 KB

README.md

File metadata and controls

78 lines (66 loc) · 2.41 KB
Raw

RubiX Command Line Interface

CircleCI License Coverage Status

Documentation

For full information on how to use the SDK and deploy a function to Knative, refer to our Documentation here.

Usage

Prerequisite

The CLI requires the following :

  • GoLang
  • Git

Build Steps

Clone project

$ mkdir $GOPATH/src/github.com/rubixFunctions
$ cd $GOPATH/src/github.com/rubixFunctions
$ git clone git@github.com:rubixFunctions/r3x-cli.git
$ cd r3x-cli
$ go build

After building the project, add the binary r3x-cli to $PATH

Using CLI

To get help :

$ r3x help

Bootstrap a Function as a Container

$ r3x init hello-function --type js

NOTE Function will be initialized with an Apache 2.0 License as standard, if you require a different License use the license tag :

$ r3x init hello-function --type js --license MIT

Alternativly you can initalize a function with no License by :

$ r3x init hello-function --type js --license none

Supported Languages

RubiX supports the following:

  • JavaScript : --type js
  • Golang : --type go
  • Python : --type py
  • Haskell : --type hs

Create a Function as a Container Image

The create function image locally:

$ cd <<function dir>>
$ r3x build -n <<Repo Name or Org>>

To create and push an image to Docker Hub:

$ r3x build -p -n <<Repo Name or Org>>

To create and push an image to Quay.io

$ r3x build -p -q -n <<Repo Name or Org>>

Deploy a Function as a Container

On success of the create command, a service.yaml file is generated and can be used to deploy the Function to Knative. For full instructions on this process see our Documentation

Alternatively, a Function as a Container can be run like any other container using a runtime like Docker, for example:

$ docker run -t -p 8080:8080 <<image tag>>

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details