CLI

The Velocity CLI allows you to create and run serverless Velocity functions from your terminal.
Explore the docs »

Table of Contents

1. About
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contact

About

The CLI is written in Go using the Cobra framework and Bubbletea as a TUI. It allows you to create, delete and invoke Velocity functions.

(back to top)

Getting Started

This section outlines how to install the CLI to get started creating functions.

Installation

Download the precompiled binary for your operating system on the release page

(back to top)

Usage

Creating a function

Create a file called function.js and input the following code

module.exports = (args) => {
    return {
        hello: "world",
    }
}

Next, you have to create a zip file containing this code. If you are on windows with powershell, use the following command

Compress-Archive -LiteralPath .\function.js -DestinationPath  code.zip

On Linux/Mac, use the following command

zip code.zip function.js

Next, create a function by running the following command

.\cli.exe create --name demo-func --file-path code.zip --handler function

Invoking a function

To invoke a function, run the following command

.\cli.exe invoke --name demo-func

Roadmap

• Add support for updating functions
• Pass in parameters from the command line

(back to top)

Contact

Utibeabasi Umanah - @utibeumanah_ - utibeabasiumanah6@gmail.com

Project Link: https://github.com/runvelocity

(back to top)