at_tools
at_tools copied to clipboard
at_cli needs a cleanup / refresh of both docs and code
Describe the bug
- README is incomplete versus the functionality offered
- README contains typos (e.g.
firtname) and incorrect commands (e.g.dart run bin/main.dart -v scan -a true -a @alice) - Tool is non-obvious to use
- Code contains use of deprecated APIs
Steps to reproduce
Try using the tool with no prior knowledge.
Expected behavior
- Fix the README - make it complete, accurate, and typo-free
- Running with --help should minimally print a link to the examples section of the README, to save on users having to find the documentation link themselves.
- In addition to listing the accepted arguments and their meaning, --help should also print an accurate list of 'commands' and 'verbs'
- Ideally, --help
should print detailed info about that command or verb - Need to clean up the code, remove use of deprecated APIs, etc
Screenshots
No response
Smartphones
No response
Were you using an atApplication when the bug was found?
No response
Additional context
No response
- [ ] It's not clear what the set of arguments has to be provided for each verb
- [ ] It's not clear what is the difference between verb and command
- [ ] From the
at_cliitself it's not possible to know what verbs can be issued - [ ] The keys file contains name of the atsign. So in case of using keys file (although I believe it should be used always - one more point to usage documentation) it would make sense to skip
--atsignparam. - [ ] Deletion shows the syntax
syntax delete:@<atkey> \n e.g delete:phone@alice"whilst the right syntaxdelete -k phone - [ ]
statsusage isn't clear at all. Any syntax returnsnullas a result
Moving to backlog as we have higher priority work on at the moment