Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getoperate.com/llms.txt

Use this file to discover all available pages before exploring further.

Listing flows

The getOperate flow list command is used to list all flows in the remote workspace.
getOperate flow

Pushing a flow

Pushing a flow to a getOperate instance is done using the getOperate flow push command.
getOperate flow push <file_path> <remote_path>

Arguments

ArgumentDescription
file_pathThe path to the flow file to push.
remote_pathThe remote path where the flow specification should be pushed.

Examples

  • Push the flow located at path/to/local/flow.yaml to the remote path f/flows/test.
getOperate flow push path/to/local/flow.yaml f/flows/test

Creating a new flow

The getOperate flow bootstrap command is used to create a new flow locally.
getOperate flow bootstrap [--summary <summary>] [--description <description>] <path>

Arguments

ArgumentDescription
pathThe path of the flow to be created.

Examples

Create a new flow f/flows/flashy_flow
getOperate flow bootstrap f/flows/flashy_flow

Running a flow

Running a flow by its path s done using the getOperate flow run command.
getOperate flow run <remote_path> [options]

Arguments

ArgumentDescription
remote_pathThe path of the flow to be run.

Options

OptionParametersDescription
-d, --datadataInputs specified as a JSON string or a file using @filename or stdin using @- . Resources and variables must be passed using “res:..."or"res:..." or "var:…” For example getOperate flow run u/henri/message_to_slack -d '{"slack":"$res:u/henri/henri_slack_perso","channel":"general","text":"hello dear team"}'
-s, --silentNoneDo not ouput anything other then the final output. Useful for scripting.

Remote path format

<u|g|f>/<username|group|folder>/...