[Improvement] Improve help system and provide extra help and examples in Gravitino CLI

apache / gravitino

World's most powerful open data catalog for building a high-performance, geo-distributed and federated metadata lake.

https://gravitino.apache.org

Apache License 2.0

1.1k stars 348 forks source link

[Improvement] Improve help system and provide extra help and examples in Gravitino CLI #5568

Open justinmclean opened 2 weeks ago

justinmclean commented 2 weeks ago

What would you like to be improved?

Add a help command to provide help and examples on each entity including:

[ ] #5603
[ ] catalogs
[ ] schema
[ ] users
[ ] groups
[ ] roles
[ ] tags
[ ] tables
[ ] columns
[ ] filesets
[ ] topics

The command would take the form cli <entity> help e.g. cli metalake help.

How should we improve?

For each entity provide more detailed help and provide examples of use - the existing example in cli.cmd can be used.

chenyuan99 commented 13 hours ago

whtat exactly cli.cmd you mean? do you mean cli.md ?

justinmclean commented 12 hours ago

The Gravitino CLI - you can see the PR for metalakes here. Currently, you could do catalogs, schema, users, groups, roles, or tags, the rest are waiting of PRs to be merged.

chenyuan99 commented 1 hour ago

I see. Thanks Justin.