Add detailed usage examples for CLI flags (--open, --first, --auth)

[nandhan262006]

💡 Summary

The good‑first‑issue CLI supports several command‑line flags such as --open, --first, and --auth, but the README only lists them briefly. More detailed usage examples would help new contributors understand how to use the tool effectively.

🔧 Suggested Improvement

• In the README, add a “Usage Examples” section showing how to run the CLI with each flag.
  For example:
• Explain what each flag does in a sentence or two.
• Optionally add a “When to use this flag” note for each.

✅ Expected Outcome

• Beginners to the tool can quickly understand how to use the flags.
• Reduced confusion and fewer questions about what each flag is for.
• Easier onboarding for new users of the CLI.

[deepakmethre07]

Hi @nandhan262006

This looks like a great improvement for usability. I’d like to work on this.

I’ll add a “Usage Examples” section in the README that:

• Explains each flag (--open, --first, --auth) clearly
• Provides practical command examples
• Includes short notes on when to use each flag

I’ll make sure the examples are beginner-friendly and easy to follow.

I’ll submit a PR soon. Thanks!

[drkrillo]

Hi @deepakmethre07 !

The only CLI flags the code has now is --output (recently added by a collaborator).

I added an issue for extending the how-it-works.md in /docs, #72 .

It would be great if you want to contribute with it. Let me know if you need any help!!

[drkrillo]

Hi @nandhan262006 !

Thanks for your interest in this repository and your observations.

Currently, the CLI only supports --output flag.

There are issues open like #72 waiting for someone to contribute, adding info on how to run the project locally.
Would you be interested in working on it?
#72.

I can help you in the process