search

dora-rs / dora

DORA (Dataflow-Oriented Robotic Application) is middleware designed to streamline and simplify the creation of AI-based robotic applications. It offers low latency, composable, and distributed dataflow capabilities. Applications are modeled as directed graphs, also referred to as pipelines.
https://dora-rs.ai
Apache License 2.0
1.35k stars 68 forks source link

Provide help messages for CLI #519

Closed phil-opp closed 1 month ago

phil-opp commented 1 month ago

Example output:

Start the given dataflow path. Attach a name to the running dataflow by using --name

Usage: dora start [OPTIONS] <PATH>

Arguments:
  <PATH>  Path to the dataflow descriptor file

Options:
      --name <NAME>                          Assign a name to the dataflow
      --coordinator-addr <COORDINATOR_ADDR>  
      --attach                               Attach to the dataflow and wait for its completion
      --hot-reload                           Enable hot reloading (Python only)
  -h, --help                                 Print help

I didn't add help output for --coordinator-addr yet because I want to implements some other improvements there.