Cox-Automotive/alks-cli

CLI session open options format not obvious

Closed this issue · 0 comments

Just a Minor annoyance since I havn't used the CLI in months.

The format of the -r and -a options isn't obvious from help or readme.md. I tried copying from ALKS web gui and the list presented when you don't provide -r or -a. Neither worked and threw a no permissions error.

I figured it out by looking through the source code to see exactly what it wanted. Realized later that running alks developer accounts gave me the format needed. Seems so obvious now that the delimiter is :: but I can see this as a major frustration to a newbie (or someone like me who has been using the desktop app for too long).

Expected: copy and paste from the alks session open list into a command line option to eliminate the need for user input

Observed: Format of list doesn't match with command line option format

Suggested fixes:

  • update documentation with an example
  • create a single command line option with both role and account in single string that can be copy and pasted from the alks session open list