Skip to main content

A tool to run predefined workflows in YAML formats

Project description

Project generated with PyScaffold

doc-agent

A simple command line interface to run a workflow defined in a YAML file.

Installation

You can install doc-agent via pip:

To install doc-agent, run this command in your terminal .. code-block:: bash

$ pip install doc-agent

If you don’t have pip installed, this Python installation guide can guide you through the process.

Usage

After installing doc-agent, you can use it from the command line. Here are some examples:

$ doc-agent --help

Quickstart

To use doc-agent, you need to create a YAML file with the workflow you want to run. Here is an example:

  1. Generate a example workflow file:

$ doc-agent generate
  1. Test the workflow:

$ doc-agent test workflow.yml
  1. Run the workflow:

$ doc-agent run workflow.yml

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page