Skip to content

Commit

Permalink
[Minor] Update command usage and add usage tracker in Gravitino CLI (#…
Browse files Browse the repository at this point in the history
…6204)

### What changes were proposed in this pull request?

Update command usage and add usage tracker

### Why are the changes needed?

So everything is up to date and we can see many many people look up the
CLI docs.

Fix: # N/A

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Tested locally.

Co-authored-by: Justin Mclean <[email protected]>
  • Loading branch information
github-actions[bot] and justinmclean authored Jan 13, 2025
1 parent ea1bbc5 commit d3c7e36
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,17 @@ The general structure for running commands with the Gravitino CLI is `gcli entit
usage: gcli [metalake|catalog|schema|model|table|column|user|group|tag|topic|fileset] [list|details|create|delete|update|set|remove|properties|revoke|grant] [options]
Options
usage: gcli
-a,--audit display audit information
-a,--audit display audit information
--alias <arg> model aliases
--all all operation for --enable
--auto <arg> column value auto-increments (true/false)
-c,--comment <arg> entity comment
--columnfile <arg> CSV file describing columns
-d,--distribution display distribution information
--datatype <arg> column data type
--default <arg> default column value
--disable disable entities
--enable enable entities
-f,--force force operation
-g,--group <arg> group name
-h,--help command help information
Expand All @@ -52,13 +56,15 @@ The general structure for running commands with the Gravitino CLI is `gcli entit
-p,--properties <arg> property name/value pairs
--partition display partition information
--position <arg> position of column
--privilege <arg> privilege(s)
-r,--role <arg> role name
--rename <arg> new entity name
-s,--server Gravitino server version
--simple simple authentication
--sortorder display sortorder information
-t,--tag <arg> tag name
-u,--url <arg> Gravitino URL (default: http://localhost:8090)
--uri <arg> model version artifact
-v,--version Gravitino client version
-V,--value <arg> property value
-x,--index display index information
Expand Down Expand Up @@ -950,4 +956,6 @@ gcli <normal command> --simple

```bash
gcli <normal command> --simple --login userName
```
```

<img src="https://analytics.apache.org/matomo.php?idsite=62&rec=1&bots=1&action_name=CLI" alt="" />

0 comments on commit d3c7e36

Please sign in to comment.