Skip to content

AlvaxAI/doc-agent

Repository files navigation

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

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages