npm

Need private packages and team management tools?Check out npm Orgs. »

@tideflowio/tideflow-agent

0.4.0 • Public • Published

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

install

npm i @tideflowio/tideflow-agent

Downloadsweekly downloads

38

version

0.4.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability