workflow

Documentation

Index

• Variables

Variables

var Deploy = &cobra.Command{
	Use:   "deploy ./PATH_TO_WORKFLOW_FILE",
	Short: "Deploy a workflow",
	Long: `Deploy a workflow on the Network.

To get more information, see the [deploy page from the documentation](https://docs.mesg.tech/workflow/deploy.html)`,
	Args: cobra.MinimumNArgs(1),
	Example: `mesg-core workflow deploy ./PATH_TO_WORKFLOW_FILE.yml
mesg-core workflow deploy ./PATH_TO_WORKFLOW_FILE.yml --account ACCOUNT --amount AMOUNT --confirm`,
	Run:               deployHandler,
	DisableAutoGenTag: true,
}

Deploy run the deploy command for a workflow

var Detail = &cobra.Command{
	Use:               "detail WORKFLOW_ID",
	Short:             "List details of a workflow",
	Args:              cobra.MinimumNArgs(1),
	Example:           "mesg-core workflow detail WORKFLOW_ID",
	Run:               detailHandler,
	DisableAutoGenTag: true,
}

Detail of the workflow

var Kill = &cobra.Command{
	Use:   "kill WORKFLOW_ID",
	Short: "Kill a workflow from the Network and get back its token",
	Args:  cobra.MinimumNArgs(1),
	Example: `mesg-core workflow kill WORKFLOW_ID
mesg-core workflow kill WORKFLOW_ID --account ACCOUNT --confirm`,
	Run:               killHandler,
	DisableAutoGenTag: true,
}

Kill a workflow

var List = &cobra.Command{
	Use:   "list",
	Short: "List all deployed workflows",
	Long: `List all workflows deployed on the Network.

Optionally, you can filter the workflows deployed by a specific account.

This command will return basic information. To have more details, see the [detail command](mesg-core_workflow_detail.md).`,
	Example: `mesg-core workflow list
mesg-core workflow list --account ACCOUNT`,
	Run:               listHandler,
	DisableAutoGenTag: true,
}

List workflows

var Log = &cobra.Command{
	Use:   "log WORKFLOW_ID",
	Short: "Log executions of a workflow",
	Args:  cobra.MinimumNArgs(1),
	Example: `mesg-core workflow log WORKFLOW_ID
	mesg-core workflow log WORKFLOW_ID --account ACCOUNT_ID
mesg-core workflow log WORKFLOW_ID --execution EXECUTION_ID
mesg-core workflow log WORKFLOW_ID --task TASK_ID
mesg-core workflow log WORKFLOW_ID --from DATE --to DATE`,
	Run:               logHandler,
	DisableAutoGenTag: true,
}

Log workflow executions

var Pause = &cobra.Command{
	Use:   "pause WORKFLOW_ID",
	Short: "Stop a workflow without killing it",
	Example: `mesg-core workflow pause WORKFLOW_ID
mesg-core workflow pause WORKFLOW_ID --account ACCOUNT_ID --confirm`,
	Run:               pauseHandler,
	DisableAutoGenTag: true,
}

Pause run the pause command for a workflow

var Resume = &cobra.Command{
	Use:   "resume WORKFLOW_ID",
	Short: "Resume a previously paused workflow",
	Long: `Resume a previously paused workflow.

To pause a workflow, see the [pause command](mesg-core_workflow_pause.md)`,
	Example: `mesg-core workflow resume WORKFLOW_ID
mesg-core workflow resume WORKFLOW_ID --account ACCOUNT_ID --confirm`,
	Run:               resumeHandler,
	DisableAutoGenTag: true,
}

Resume run the resume command for a workflow

var Test = &cobra.Command{
	Use:   "test ./PATH_TO_WORKFLOW_FILE",
	Short: "Test a workflow",
	Long: `Test a workflow locally

To get more information, see the [test page from the documentation](https://docs.mesg.tech/workflow/test.html)`,
	Args: cobra.MinimumNArgs(1),
	Example: `mesg-core workflow test ./PATH_TO_WORKFLOW_FILE.yml
mesg-core workflow test ./PATH_TO_WORKFLOW_FILE.yml --live
mesg-core workflow test ./PATH_TO_WORKFLOW_FILE.yml --task TASK_ID --live
mesg-core workflow test ./PATH_TO_WORKFLOW_FILE.yml --task TASK_ID --event ./PATH_TO_EVENT_DATA_FILE.yml
mesg-core workflow test ./PATH_TO_WORKFLOW_FILE.yml --live --keep-alive`,
	Run:               testHandler,
	DisableAutoGenTag: true,
}

Test run the test command for a workflow

var Topup = &cobra.Command{
	Use:   "topup WORKFLOW_ID",
	Short: "Top-up a workflow",
	Long: `Top-up a workflow.
Add more token to a existing workflow.`,
	Example: `mesg-core workflow topup WORKFLOW_ID
mesg-core workflow topup WORKFLOW_ID --amount AMOUNT --account ACCOUNT_ID --confirm`,
	Run:               topupHandler,
	DisableAutoGenTag: true,
}

Topup a workflow

var Validate = &cobra.Command{
	Use:   "validate ./PATH_TO_WORKFLOW_FILE",
	Short: "Validate a workflow",
	Long: `Validate a workflow.

To get more information, see the [deploy page from the documentation](https://docs.mesg.tech/workflow/validate.html)`,
	Args:              cobra.MinimumNArgs(1),
	Example:           "mesg-core workflow validate ./PATH_TO_WORKFLOW_FILE.yml",
	Run:               validateHandler,
	DisableAutoGenTag: true,
}

Validate run the validate command for a workflow