search

abcxyz / jvs

Apache License 2.0
8 stars 0 forks source link

Update docs about jvsctl usage #188

Closed yolocs closed 1 year ago

yolocs commented 1 year ago

After this change: https://github.com/abcxyz/jvs/pull/186

sethvargo commented 1 year ago

What exactly do we need to update? The CLI is backwards compatible, so all of the examples should apply. I don't want to have two source of truth for docs. jvsctl -h should be the source of truth imo.

sethvargo commented 1 year ago

@yolocs do you know which docs we need to update?

yolocs commented 1 year ago

https://github.com/abcxyz/jvs/blob/main/docs/cli-tool.md - Thinking about adding an example using gcloud to pass the auth token. And clean up some duplicated examples that already present in the -h output.

sethvargo commented 1 year ago

I think I would prefer to just provide a single example in the README and then ask users to run jvsctl token -h for more examples. That ensures the example is versioned with the binary.

yolocs commented 1 year ago

Close per clean up in https://github.com/abcxyz/jvs/pull/213