[Proposal] Create a new IotDev CLI based on System.CommandLine

[shaggygi]

Core Objective

If possible, I recommend we create a new console project called IotDev (short for IoT Device Development). The intention is to utilize the new System.CommandLine and deprecate DeviceApiTester at some point. IotDev can be stored at the same folder location and would enable to continue adding features to current DeviceApiTester while learning/adding to IotDev. This might be a good opportunity to "dog-food" and provide feedback to the System.CommandLine repo for bugs/features, as well.

Early notes about System.CommandLine

• Wiki found here: https://github.com/dotnet/command-line-api/wiki
• This, of course, is in the very early alpha stage. Seems to have potential, though.
• I like the command > subcommand feature where you can have something like...
  iotdev i2c write [options]
iotdev spi read -b 1 -c 4
  This appears to be much better how help info can be displayed while digging down to specific command level.
• There is a nifty suggestions feature.
• It also includes a [debug] directive for attaching.
• There is a beginning app model codename DragonFruit to try out. Also noticed another called StarFruit (which might be similar to the current CLI package that uses attributes).

Random Thoughts

• IMHO, IotDev seems like a better "branding" and flows better at the command line.
  DeviceApiTester script-run -f MyIotScript.csx
  versus...
  iotdev script run -f MyIotScript.csx

Future Work

There are a few things that will need to be completed. I'm sure there are other items I'm missing. Chime in.

• Create and add an initial solution with bare projects as a starting point.

• Determine the approach how each area should be tested. This would go in the IotDev.Tests project, of course. Also might be a good exercise to see how to mock interfaces.

• Setup any CI/CD infrastructure components needed for repo. Not my expertise 😕

• Setup a NuGet package.

  This will be helpful to support an IotDev Global Tool which makes it easy to install on development boards.

  • .NET Core Global Tools overview
  • Create a .NET Core Global Tool using the .NET Core CLI

• Determine structure of commands and best approach utilizing System.CommandLine.

• Migrate commands already defined in DeviceApiTester

• Create README with details on usage.

[shaggygi]

No plans do so for now. I will continue to review progress/features of System.CommandLine and add thoughts here for possible future use. Closing for now.