Enhance CLI usability with clearer error messages and improved help documentation

[jenniferjiangkells]

The HealthChain CLI (healthchain/cli.py) could provide a better developer experience through clearer error messages, more helpful text, and potentially command aliases.

File: healthchain/cli.py

Current state:
The CLI works but could be more beginner-friendly and provide better guidance when errors occur.

Goal:
Improve the CLI user experience through incremental enhancements.

Suggested improvements (pick 2-3 to start):

• Add more descriptive error messages when commands fail
• Improve help text for each command with examples
• Add validation for common user input errors with helpful suggestions
• Include usage examples in command help (--help)
• Add color-coded output for success/error messages (optional)
• Consider command aliases for frequently used operations

Acceptance Criteria:

• Error messages clearly explain what went wrong AND how to fix it
• All commands have improved --help text with examples
• Common error cases provide actionable guidance
• Test the CLI manually to verify improvements
• Update CLI documentation if needed

Example improvements:

# Before
raise ValueError("Invalid configuration")

# After
raise ValueError(
    "Invalid configuration file: 'sandbox' field is required. "
    "Example:\n"
    "  sandbox:\n"
    "    use_case: 'cds'\n"
    "See https://docs.healthchain.org/cli for more information."
)

Resources:

• Typer documentation (if using Typer)
• Run healthchain --help and each subcommand to audit current state
• Look at well-designed CLIs for inspiration (e.g., poetry, black)

[Mr-kings042]

I would like to work on this. could you please assign it to me?

[jenniferjiangkells]

@Mr-kings042 Yours to work on!

[SnehaKumari2005]

I would like to contribute to this issue for hacktoberfest. Please assign this issue to me.

[jenniferjiangkells]

@SnehaKumari2005 Please respect our code of conduct and do not spam comment on issues.