{"id":15291435,"url":"https://github.com/azure/iotc-explorer","last_synced_at":"2025-10-07T04:31:06.910Z","repository":{"id":57276339,"uuid":"147452650","full_name":"Azure/iotc-explorer","owner":"Azure","description":"DEPRECATED: Command line interface for interacting with Azure IoT Central devices and applications","archived":true,"fork":false,"pushed_at":"2020-09-04T14:17:57.000Z","size":260,"stargazers_count":6,"open_issues_count":3,"forks_count":5,"subscribers_count":41,"default_branch":"master","last_synced_at":"2024-12-22T18:05:12.810Z","etag":null,"topics":["azure","central","device","iot","iot-central"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Azure.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-05T03:10:49.000Z","updated_at":"2023-10-12T02:32:49.000Z","dependencies_parsed_at":"2022-08-25T03:42:12.116Z","dependency_job_id":null,"html_url":"https://github.com/Azure/iotc-explorer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fiotc-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fiotc-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fiotc-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fiotc-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azure","download_url":"https://codeload.github.com/Azure/iotc-explorer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235586523,"owners_count":19014035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure","central","device","iot","iot-central"],"created_at":"2024-09-30T16:12:27.721Z","updated_at":"2025-10-07T04:31:01.610Z","avatar_url":"https://github.com/Azure.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# PLEASE NOTE, THIS PROJECT HAS BEEN DEPRECATED\n\n*`iotc-explorer` is soon to be retired, and has been replaced by the [Azure CLI IoT \nExtension](https://aka.ms/iotcli).*\n\n# iotc-explorer\n\n[![Build Status](https://travis-ci.org/Azure/iotc-explorer.svg?branch=master)](https://travis-ci.org/Azure/iotc-explorer)\n[![NPM version](https://img.shields.io/npm/v/iotc-explorer.svg)](https://www.npmjs.com/package/iotc-explorer)\n\nCommand-line interface for interacting with Azure IoT Central devices and\napplications.\n\n## Prerequisites\n+ Node.js version 8.x or higher - https://nodejs.org\n+ You will need Administrator access in IoT Central to generate an access token\n\n## Installing `iotc-explorer`\n\nRun the following command from your command line to install:\n\n```\nnpm install -g iotc-explorer\n```\n\n\u003e NOTE: You will typically need to run the install command with `sudo` in Unix-like environments.\n\nOnce installed, you can run `iotc-explorer --help` to verify everything is\nworking and get an overview of the available commands:\n\n```\n$ iotc-explorer --help\n\niotc-explorer \u003ccommand\u003e\n\nCommands:\n  iotc-explorer config                       Manage configuration values for the CLI\n  iotc-explorer get-twin \u003cdeviceId\u003e          Get the IoT Hub device twin for a specific device\n  iotc-explorer login [token]                Log in to an Azure IoT Central application\n  iotc-explorer logout                       Log out of the Azure IoT Central application by clearing\n                                             the saved login token\n  iotc-explorer monitor-messages [deviceId]  Monitor messages being sent to a specific device (if\n                                             device id is provided), or all devices\n\nOptions:\n  --version  Show version number                                                           [boolean]\n  --help     Show help                                                                     [boolean]\n```\n\n## Running `iotc-explorer`\n\nBelow are some commands and common options that you can run when using\n`iotc-explorer`. To view the full set of commands and options, you can pass\n`--help` to `iotc-explorer` or any of its subcommands.\n\n### Login\n\nBefore you get going, you need to have an administrator of your IoT Central application to get an access token for you to use. The administrator takes the following steps:\n- Go to **Administration/Access Tokens**. \n- Click **Generate**, and enter a Token name.  \n- Click **Next**, and **copy the Token value**.\n\n\u003e NOTE: The token value will only be shown once, so it must be copied before closing the dialog. After closing the dialog, it will never be shown again.\n\nYou can then use that token to log in to the CLI by running:\n\n```sh\niotc-explorer login \"\u003cToken value\u003e\"\n```\n\nIf you would rather not have the token persisted in your shell history, you can\nleave the token out and instead provide it when prompted:\n\n```\niotc-explorer login\n```\n\n### Monitor Device Messages\n\nYou can watch the messages coming from either a specific device or all devices\nin your application using the `monitor-messages` command. This will start a\nwatcher that will continuously output new messages as they come in.\n\nTo watch all devices in your application, run the following command:\n\n```\niotc-explorer monitor-messages\n```\n\nTo watch a specific device, just add the Device ID to the end of the command:\n\n```\niotc-explorer monitor-messages \u003cyour-device-id\u003e\n```\n\nYou can also have the command output a more machine-friendly format by adding\nthe `--raw` option to the command:\n\n```\niotc-explorer monitor-messages --raw\n```\n\nYou can also turn off colored output by adding the `--no-color` option\nto the command:\n\n```\niotc-explorer monitor-messages --no-color\n```\n\n### Get Device Twin\n\nYou can use the `get-twin` command to get the contents of the twin for an IoT\nCentral device. To do so, run the following command:\n\n```\niotc-explorer get-twin \u003cyour-device-id\u003e\n```\n\nAs with `monitor-messages`, you can get a more machine-friendly output by\npassing the `--raw` option:\n\n```\niotc-explorer get-twin \u003cyour-device-id\u003e --raw\n```\n\nAs with `monitor-messages`, you can also turn off colored output by\npassing the `--no-color` option:\n\n```\niotc-explorer get-twin \u003cyour-device-id\u003e --no-color\n```\n\n### Config\n\nTo set, get, remove or list config settings, run the following commands:\n\n```\niotc-explorer config set \u003ckey\u003e \u003cvalue\u003e\niotc-explorer config get \u003ckey\u003e\niotc-explorer config delete \u003ckey\u003e\niotc-explorer config list\n```\n\n#### Allowed config values:\n\n| Config key         | Config value type   | Description                                                                                            |\n|--------------------|---------------------|--------------------------------------------------------------------------------------------------------|\n| `log.color` | `boolean`           | Default value on whether to print JSON data in colored format. Can be overwritten for an individual CLI call by setting `--color`/`--no-color` option. |\n| `log.raw`   | `boolean`           | Default value on whether to print JSON data in raw format. Can be overwritten for an individual CLI call by setting `--raw`/`--no-raw` option. |\n\n### Logout\n\nTo remove your saved login credentials, run the following command:\n\n```\niotc-explorer logout\n```\n\n## Contributing\n\n### Developer Setup\n\nFor your first time setup, make sure you've done the following:\n\n 1. Make sure you have the [prerequisites](#prerequisites) installed.\n 2. Clone this repository to wherever you want to develop.\n 3. Run `cd iotc-explorer` to enter the repository folder.\n 4. Run `npm install`, then `npm run build` to get things configured.\n\n### Writing Code\n\nOnce you're ready to start changing code, it is recommended that you link your\nproject to the `iotc-explorer` executable by running the following (may require\n`sudo`):\n\n```\nnpm link\n```\n\nNow, when you run `iotc-explorer`, it will point to the code in your development\nfolder. To make the executable reflect your changes as they're made, set up a\nwatch task in a terminal window to the side:\n\n```\nnpm run watch\n```\n\nNow, whenever you make edits to the code you will be able to use them by running\nthe `iotc-explorer` command on your machine.\n\nWhen you're ready to stop local development, you can remove your connection to\nthe `iotc-explorer` executable by running the following (may require `sudo`):\n\n```\nnpm unlink\n```\n\n### Committing\n\nThis project uses the [Angular commit style][angular commit style] for\ngenerating changelogs and determining release versions. Any pull request with\ncommits that don't follow this style will fail continuous integration. If you're\nnot familiar with the style, you can run the following instead of the standard\n`git commit` to get a guided walkthrough to generating your commit message:\n\n```\nnpm run commit\n```\n\n### Releasing\n\nWhen it's time to cut a new release, run the following from the repository\nfolder. This will (1) fetch the latest updates, (2) automatically update the\npackage version and the changelog, (3) publish the package and (4) push the\nchanges back into the repository:\n\n```\ngit checkout master\ngit pull\nnpm test\nnpm run release\ngit push --follow-tags\nnpm publish\n```\n\n### Contributor License Agreement\n\nThis project welcomes contributions and suggestions.  Most contributions require\nyou to agree to a Contributor License Agreement (CLA) declaring that you have\nthe right to, and actually do, grant us the rights to use your contribution. For\ndetails, visit https://cla.microsoft.com.\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether\nyou need to provide a CLA and decorate the PR appropriately (e.g., label,\ncomment). Simply follow the instructions provided by the bot. You will only need\nto do this once across all repos using our CLA.\n\n### Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct][]. For more\ninformation see the [Code of Conduct FAQ][] or contact\n[opencode@microsoft.com][] with any additional questions or comments.\n\n[Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/\n[Code of Conduct FAQ]: https://opensource.microsoft.com/codeofconduct/faq/\n[opencode@microsoft.com]: mailto:opencode@microsoft.com\n[angular commit style]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazure%2Fiotc-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazure%2Fiotc-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazure%2Fiotc-explorer/lists"}