Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

at_cli needs a cleanup / refresh of both docs and code #240

Open
gkc opened this issue Oct 12, 2022 · 2 comments
Open

at_cli needs a cleanup / refresh of both docs and code #240

gkc opened this issue Oct 12, 2022 · 2 comments
Assignees
Labels
5 SP 5 Story Points - 3 Days Medium bug Something isn't working PR48 Oct 2022 Sprint Planning PR49

Comments

@gkc
Copy link
Contributor

gkc commented Oct 12, 2022

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

@gkc gkc added the bug Something isn't working label Oct 12, 2022
@gkc gkc changed the title at_cli needs a cleanup / refresh at_cli needs a cleanup / refresh of both docs and code Oct 12, 2022
@ralfeus
Copy link

ralfeus commented Oct 13, 2022

  • 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_cli itself 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 --atsign param.
  • Deletion shows the syntax syntax delete:@<atkey> \n e.g delete:phone@alice" whilst the right syntax delete -k phone
  • stats usage isn't clear at all. Any syntax returns null as a result

@ksanty ksanty added 5 SP 5 Story Points - 3 Days Medium bug Something isn't working PR48 Oct 2022 Sprint Planning and removed bug Something isn't working 5 SP 5 Story Points - 3 Days Medium labels Oct 18, 2022
@gkc
Copy link
Contributor Author

gkc commented Nov 13, 2022

Moving to backlog as we have higher priority work on at the moment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 SP 5 Story Points - 3 Days Medium bug Something isn't working PR48 Oct 2022 Sprint Planning PR49
Projects
None yet
Development

No branches or pull requests

5 participants