Usage

Running a workflow

Run your first workflow.

$ jyfti run https://raw.githubusercontent.com/jyfti/jyfti/master/workflows/retrieve-readme.json

Jyfti runs remote and local workflows. The preferred way of developing workflows is within a local Jyfti project.

Initialize a Jyfti project within your current directory.

$ jyfti init

This results in a jyfti.json to be created where the configuration for your Jyfti project resides.

Then, generate your first workflow.

$ jyfti generate workflow retrieve-readme

The workflow is generated into the sourceRoot directory as retrieve-readme.json. It serves you as a foundation to create your first productive workflow.

Run the workflow to completion.

$ jyfti run retrieve-readme

? The GitHub organization (jyfti)

? The GitHub repository (jyfti)

Jyfti prompts for inputs that the workflow expects. Note that inputs can also be passed directly.

$ jyfti run retrieve-readme jyfti jyfti

Step-by-step execution

While jyfti run <name> executes a workflow from start to finish, Jifty can also execute a workflow step-by-step persisting intermediate states to disk.

A step-by-step workflow run is created via the create subcommand.

$ jyfti run create retrieve-readme jyfti jyfti

Initialized

The create subcommand validates the input and writes the initial state to disk. The run can get advanced with the step subcommand.

$ jyfti run step retrieve-readme

Completed 0

At any point, the status, the state and the variables can be requested.

$ jyfti run status retrieve-readme

[Pending] At step [0]

$ jyfti run state retrieve-readme

{

"path": [

0

],

"inputs": {

"org": "jyfti",

"repo": "jyfti"

},

"evaluations": []

}

$ jyfti run vars retrieve-readme

{

"org": "jyfti",

"repo": "jyfti"

}

A call to complete runs it to completion.

$ jyfti run complete retrieve-readme

Completed 0

Environments

Besides inputs, a workflow run accepts an environment. While inputs are passed as values, an environment is passed as a reference to an environment file. The environment files are stored in the environment directory defined via envRoot in the jyfti.json.

You can list the existing environments.

$ jyfti environment list

default

prod

local

Even if no environment files exists, there is always the default environment. This environment is also used each time an environment is not explicitly passed.

$ jyfti run retrieve-readme -e default

An environment is a JSON object where each key can be assigned an arbitrary json value. It can be viewed which prints the environment file.

$ jyfti environment view local

{

"baseUrl": "http://localhost:8080/"

}