Skip to content
Run commands as workflow steps via Tideflow. Windows / Linux / MacOS
JavaScript Shell
Branch: master
Clone or download
Latest commit 3398e88 Nov 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci - Feb 24, 2019
.vscode github_ci_service WIP Aug 16, 2019
helpers Update docs Nov 11, 2019
services Authorise GH apps and implement checksuite hooks Nov 9, 2019
test - Feb 24, 2019
.gitignore Fix #2 Feb 25, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Feb 24, 2019
LICENSE.md - Feb 24, 2019
README.md Update docs Nov 11, 2019
agent.js Update docs Nov 11, 2019
index.js Allow to specify Tideflow URL via cli Jul 27, 2019
package-lock.json bump version Nov 11, 2019
package.json Bump version Nov 11, 2019
publish.sh - Feb 24, 2019

README.md

Tideflow's agent CircleCI Greenkeeper badge

With Tideflow's Agent, you can run workflow's task in your own computer via TideFlow

For more information, visit TideFlow.io

Usage

npx @tideflowio/tideflow-agent -t [token] -u tideflow.example.com
$ tideflow-agent --help
Usage: index [options]

Options:
  -v, --version                       output the version number
  -c, --concurrency [concurrency]     Max number of jobs the agent should process concurrently
  -t, --token [token]                 Authentication token
  -u, --url [url]                     Tideflow url
  --noupdate                          Opt-out of update version check
  -h, --help                          output usage information

Examples:
  $ tideflow-agent --help
  $ tideflow-agent -h

Environment variables

# Specify the URL to connect to the Tideflow's platform.
# Optional. Defaults to localhost:1337 if no -u parameter set
# Example: http://subdomain.example.com:1337
TF_AGENT_URL

How to process data from previous tasks.

The result from previous tasks are sent to the agent commands via the parameter --tf_previous.

For example, if the command to run is meow, the agent will execute it as meow --tf_previous <previous-tasks-output>

The previous task's output is an stringified representation of the following JSON array:

[
  {
    "type" : "object",
    "data" : {}
  }
]

Each of the predecesor tasks results is represented as an arrray element with two root properties:

  • type: an string that defines the kind of data retuned by the previous step (object, array, file, etc)
  • data: an object containing the task's result.

Contributing

If you would like to contribute to Tideflow, check out the Contributing Guide.

License

GNU AFFERO GENERAL PUBLIC LICENSE

Developer Resources

You can’t perform that action at this time.