🐞 [Bug] Farmerbot: confused about help and completion subcommands

threefoldtech / tfgrid-sdk-go

Apache License 2.0

2 stars 4 forks source link

🐞 [Bug] Farmerbot: confused about help and completion subcommands #812

Closed A-Harby closed 6 months ago

A-Harby commented 8 months ago

What happened?

The help option in the bot has more command descriptions than in the documents.

I can't find any information about commands, including help itself. What does the completion command do?

which network/s did you face the problem on?

Dev

Twin ID/s

No response

Node ID/s

No response

Farm ID/s

No response

Contract ID/s

No response

Relevant log output

https://github.com/threefoldtech/tfgrid-sdk-go/blob/development/farmerbot/README.md

xmonader commented 8 months ago

I understand, typically you only care about version and run subcommands.

completion allows to generate completion files (when you press tab after typing farmerbot, a suggestion list will be shown), similar to https://dgraph.io/docs/howto/completion/

I'm not sure I got your question, do you want to document help subcommand? All it does is showing help for the subcommand and its flags like that

A-Harby commented 8 months ago

Just to add a command description in the docs for the version, completion, and other.