Azure / iotedgedev

The Azure IoT Edge Dev Tool greatly simplifies your Azure IoT Edge development process. It has everything you need to get started and helps with your day-to-day Edge development.
https://aka.ms/iotedgedev
Other
160 stars 70 forks source link

Update help to show recommended commands instead of deprecated ones. #592

Closed roel4ez closed 2 years ago

roel4ez commented 2 years ago

Description.

Currently the command iotedgedev --help shows which commands are deprecated, but not the proposed alternative command.

$>iotedgedev --help Usage: iotedgedev [OPTIONS] COMMAND [ARGS]...

Options: --version Show the version and exit. -h, --help Show this message and exit.

Commands: add (Deprecated) Add a new module to the solution build (Deprecated) Build the solution deploy (Deprecated) Deploy solution to IoT Edge device genconfig (Deprecated) Expand environment variables and placeholders in deployment manifest template file and copy to config folder init (Deprecated) Create a new IoT Edge solution and provision Azure resources log (Deprecated) Open a new terminal window for EdgeAgent, EdgeHub and each Edge module and save to LOGS_PATH monitor (Deprecated) Monitor messages from IoT Edge device to IoT Hub new (Deprecated) Create a new IoT Edge solution push (Deprecated) Push module images to container registry setup (Deprecated) Setup IoT Edge simulator. This must be done before starting start (Deprecated) Start IoT Edge simulator stop (Deprecated) Stop IoT Edge simulator docker Manage Docker iothub Manage IoT Hub and IoT Edge devices simulator Manage IoT Edge simulator solution Manage IoT Edge solutions

Expected result: both the iotedgedev --help and iotedgedev <command> --help should display the recommended command.