Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide help messages for CLI #519

Merged
merged 1 commit into from
May 30, 2024
Merged

Provide help messages for CLI #519

merged 1 commit into from
May 30, 2024

Conversation

phil-opp
Copy link
Collaborator

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.

@phil-opp phil-opp requested a review from haixuanTao May 30, 2024 12:23
Copy link
Collaborator

@haixuanTao haixuanTao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks!

@haixuanTao haixuanTao merged commit 7a940b8 into main May 30, 2024
17 checks passed
@haixuanTao haixuanTao deleted the cli-help branch May 30, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants