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.

Sign up for GitHub

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

Jump to bottom

Write RFC to standardize CLI commands #8849

Open
vxgmichel opened this issue Nov 4, 2024 · 0 comments
Open

Write RFC to standardize CLI commands #8849

vxgmichel opened this issue Nov 4, 2024 · 0 comments

Comments

@vxgmichel
Copy link
Contributor

We should have a document listing how CLI commands deal with common use cases. This includes:

  • Using a client without taking the risk to forget calling client.close().await
  • Using a spinner without taking the risk to forget spinner.stop_with_newline()
  • Have a non-zero return code on errors
  • Show a warning when a non-critical error occurs
  • Use stdout and stderr in a consistent way
  • Define a color scheme to use to highlight specific values
  • Etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vxgmichel