CLI COMMAND LIST

Library

Description: Lists the library out, and gives detailed information about a function.

Flags:

Flag	Function
`none`	List the library functions, if you have any broken deployments also lists them out
`-d \| details`	Lists the specific details of one library, gives in-depth information.
`-r \| readme`	when used with `-d` shows the readme of the library item

Examples:

> jellyfaas library list

> jellyfaas library -d <function name>

Apikey

Description: Sets the apikey in the local .jellyfaas file.

Example:

> jellyfaas apikey

Token

Description: Generates a token to use when calling out to functions.

Example:

> jellyfaas token

Zip

Description: Zips up a function directory ready for deployment, and optionally deploys.

Flags:

Flag	Function
`-s \| source`	Specifies the name of the directory to zip up, this can be a fully qualified path
`-o \| overwrite`	If set to true, will overwrite the exiting zip file if it already exits.
`-d \| deploy`	If set to true, will deploy the function into JellyFaaS
`-w \| wait`	If set to true will wait till deployment completes (success or fail).

Examples:

> jellyfaas zip -s ./hello-world -o true -d true

> jellyfaas zip -s /user/name/src/functions/hello-world -d true -o true -w true

> jellyfaas zip -s ./hello-world

Create

Description: Create the boiler plate code to create a function, Supports the following languages: go,php,java,dotnet,python,ruby,node

Flags:

Flag	Function
`-n \| name`	Name of the function
`-l \| language`	Language of the function, one of `go\|php\|java\|dotnet\|python\|ruby\|node`
`-d \| destination`	Destination of the function
`-a \| always`	Always create function, even if directory exists

Examples:

> jellyfaas create -d ./src/functions -l go -n hello_world

> jellyfaas create -d `pwd` -l go -n hello_world -a

> jellyfaas create -d C:\src\functions -l php -n helloworld

Spec

Description: Creates the required OpenApi Spec to place in the jellyspec.json file from json. This allows you to easily create the required data from json data that you have created/used during function development.

Flags:

Flag	Function
`-j \| json`	Input is `json`, currently this is the only supported input.
`-r \| raw`	Raw output, allowing you to pipe or pbcopy for example.
`-f \| flat`	output is one long string, not 'pretty printed'

Examples:

> jellyspec spec -j '{"foo":"bar","foo2":"bar2","output":"data"}'

> jellyspec -r spec -j '{"foo":"bar","foo2":"bar2","output":"data"}'

> jellyspec -r -f spec -j '{"foo":"bar","foo2":"bar2","output":"data"}'

Bad builds

Description: List any bad builds you have attempted to deploy (and the reason why), if you have any you can list them with list or attempt to clean up and remove any unsuccessful deployed builds, if this is not successful please contact support and we can help and explain what went wrong.

List

Flags:

Flag	Function
`-b \| buildId`	Display information on a specific build id.

Examples:

> jellyspec badbuild list

> jellyspec badbuild list -b <buildId>

Clean

Flag	Function
`-b \| buildId`	Display information on a specific build id.

> jellyspec badbuild clean -b <buildId>

Exists

Description: Checks if a function id 'shortname' exists.

List

Flags:

Flag	Function
`-n \| name`	shortname of the function from the `jellyspec.json` file.

Examples:

> jellyspec exists -n <shortname>