{"id":19204834,"url":"https://github.com/meshtastic/c-sharp","last_synced_at":"2025-05-12T16:25:55.730Z","repository":{"id":64781571,"uuid":"574958093","full_name":"meshtastic/c-sharp","owner":"meshtastic","description":"C# / .NET based command line interface and library for Meshtastic","archived":false,"fork":false,"pushed_at":"2025-04-16T00:43:57.000Z","size":1548,"stargazers_count":31,"open_issues_count":8,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-06T10:29:57.545Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/meshtastic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"thebentern","open_collective":"meshtastic"}},"created_at":"2022-12-06T12:56:11.000Z","updated_at":"2025-04-17T16:42:29.000Z","dependencies_parsed_at":"2023-02-17T09:46:34.896Z","dependency_job_id":"277fdd37-08d7-4054-ba04-e87885885e02","html_url":"https://github.com/meshtastic/c-sharp","commit_stats":{"total_commits":290,"total_committers":7,"mean_commits":41.42857142857143,"dds":0.2793103448275862,"last_synced_commit":"093b3d712195e4b5fad1b5aaacef0ec8349f94e9"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshtastic%2Fc-sharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshtastic%2Fc-sharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshtastic%2Fc-sharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meshtastic%2Fc-sharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meshtastic","download_url":"https://codeload.github.com/meshtastic/c-sharp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252954115,"owners_count":21830892,"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":[],"created_at":"2024-11-09T13:09:53.450Z","updated_at":"2025-05-12T16:25:55.705Z","avatar_url":"https://github.com/meshtastic.png","language":"C#","funding_links":["https://github.com/sponsors/thebentern","https://opencollective.com/meshtastic","https://opencollective.com/meshtastic/"],"categories":[],"sub_categories":[],"readme":"# Meshtastic C#\n\n![GitHub release downloads](https://img.shields.io/github/downloads/meshtastic/c-sharp/total)\n[![Coverage Status](https://coveralls.io/repos/github/meshtastic/c-sharp/badge.svg)](https://coveralls.io/github/meshtastic/c-sharp)\n[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/c-sharp/ci.yml?branch=master\u0026label=actions\u0026logo=github\u0026color=yellow)](https://github.com/meshtastic/c-sharp/actions/workflows/ci.yml)\n[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/c-sharp)](https://cla-assistant.io/meshtastic/c-sharp)\n[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors\u0026color=deeppink)](https://opencollective.com/meshtastic/)\n[![Vercel](https://img.shields.io/static/v1?label=Powered%20by\u0026message=Vercel\u0026style=flat\u0026logo=vercel\u0026color=000000)](https://vercel.com?utm_source=meshtastic\u0026utm_campaign=oss)\n\n## Overview\nA cross-platform C# / .NET 8 based command line interface for Meshtastic.\n\n\n\n## Stats\n\n![Alt](https://repobeats.axiom.co/api/embed/d563d12d9eb01ed9f875ad9c47dac64cd5fc521c.svg \"Repobeats analytics image\")\n\n## Installation \u0026 Usage\n\n```\nDescription:\n  Meshtastic.Cli\n\nUsage:\n  Meshtastic.Cli [command] [options]\n\nOptions:\n  --port \u003cport\u003e                                                    Target serial port for meshtastic device\n  --host \u003chost\u003e                                                    Target host ip or name for meshtastic device\n  --output \u003cJson|PrettyConsole\u003e                                    Type of output format for the command\n  -l, --log \u003cCritical|Debug|Error|Information|None|Trace|Warning\u003e  Logging level for command events [default: Information]\n  --dest \u003cdest\u003e                                                    Destination node address for command\n  -sd, --select-dest                                               Interactively select a destination from device's node list [default: False]\n  --version                                                        Show version information\n  -?, -h, --help                                                   Show help and usage information\n\nCommands:\n  list                                   List available serial ports\n  monitor                                Serial monitor for the device\n  live                                   Show a live dashboard for the device\n  info                                   Dump info about the device\n  get                                    Display one or more settings from the device\n  set                                    Save one or more settings onto the device\n  channel \u003cAdd|Disable|Enable|Save\u003e      Enable, Disable, Add, Save channels on the device\n  url \u003cGet|Set\u003e \u003curl\u003e                    Get or set shared channel url []\n  reboot \u003cseconds\u003e                       Reboot the device [default: 5]\n  metadata                               Get device metadata from the device\n  factory-reset                          Factory reset configuration of the device\n  fixed-position \u003clat\u003e \u003clon\u003e \u003caltitude\u003e  Set the device to a fixed position [default: 0]\n  text \u003cmessage\u003e                         Send a text message from the device\n  remove-node \u003cnodenum\u003e                  Remove single node by nodenum from node db of the device\n  reset-nodedb                           Reset the node db of the device\n  trace-route                            Trace the sequence of nodes routing to the destination\n  waypoint \u003clat\u003e \u003clon\u003e                   Send a waypoint from the device\n  file \u003cpath\u003e                            Get or send a file from the device\n  waypoint \u003clat\u003e \u003clon\u003e                   Send a waypoint from the device\n  file \u003cpath\u003e                            Get or send a file from the device\n  update                                 Update the firmware of the serial connected device\n  export                                 Export the profile of the connected device as yaml\n  import                                 Import the profile export from a yaml file and set the connected device\n  mqtt-proxy                             Proxy to the MQTT server referenced in the MQTT module config of the connected device\n  request-telemetry                      Request a telemetry packet from a repeater by nodenum\n  capture                                Capture all of the FromRadio messages for the device and store in MongoDB instance\n\nPS C:\\Users\\bmeadors\\Documents\\GitHub\\c-sharp\u003e dotnet run --project ./Meshtastic.Cli/Meshtastic.Cli.csproj --port COM5\nRequired command was not provided.\n\nDescription:\n  Meshtastic.Cli\n\nUsage:\n  Meshtastic.Cli [command] [options]\n\nOptions:\n  --port \u003cport\u003e                                          Target serial port for meshtastic device\n  --host \u003chost\u003e                                          Target host ip or name for meshtastic device\n  --output \u003cJson|PrettyConsole\u003e                          Type of output format for the command\n  -l, --log                                              Logging level for command events [default: Information]\n  \u003cCritical|Debug|Error|Information|None|Trace|Warning\u003e\n  --dest \u003cdest\u003e                                          Destination node address for command\n  -sd, --select-dest                                     Interactively select a destination from device's node list       \n                                                         [default: False]\n  --version                                              Show version information\n  -?, -h, --help                                         Show help and usage information\n\nCommands:\n  list                                   List available serial ports\n  monitor                                Serial monitor for the device\n  live                                   Show a live dashboard for the device\n  info                                   Dump info about the device\n  get                                    Display one or more settings from the device\n  set                                    Save one or more settings onto the device\n  channel \u003cAdd|Disable|Enable|Save\u003e      Enable, Disable, Add, Save channels on the device\n  url \u003cGet|Set\u003e \u003curl\u003e                    Get or set shared channel url []\n  reboot \u003cseconds\u003e                       Reboot the device [default: 5]\n  metadata                               Get device metadata from the device\n  factory-reset                          Factory reset configuration of the device\n  fixed-position \u003clat\u003e \u003clon\u003e \u003caltitude\u003e  Set the device to a fixed position [default: 0]\n  text \u003cmessage\u003e                         Send a text message from the device\n  remove-node \u003cnodenum\u003e                  Remove single node by nodenum from node db of the device\n  reset-nodedb                           Reset the node db of the device\n  trace-route                            Trace the sequence of nodes routing to the destination\n  canned-messages \u003cGet|Set\u003e \u003cmessages\u003e   Get or set the collection of canned messages on the device [operation: Get, ]    \n  waypoint \u003clat\u003e \u003clon\u003e                   Send a waypoint from the device\n  file \u003cpath\u003e                            Get or send a file from the device\n  update                                 Update the firmware of the serial connected device\n  export                                 Export the profile of the connected device as yaml\n  import                                 Import the profile export from a yaml file and set the connected device\n  mqtt-proxy                             Proxy to the MQTT server referenced in the MQTT module config of the connected   \n                                         device\n  request-telemetry                      Request a telemetry packet from a repeater by nodenum\n```\n\n### Example of `Meshtastic.Cli info` output with default console output level\n![image](https://user-images.githubusercontent.com/9000580/210158789-96f2c61f-1ed6-4ea0-97e0-187a27e89bd6.png)\n\n## Installation (dotnet cli / tool method)\n\n* Install the latest [dotnet 8 sdk](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) for your platform \n* Install the Meshtastic.Cli nuget package as a dotnet tool via `dotnet tool install --global Meshtastic.Cli` in your terminal of choice\n\n## Installation (standalone executable)\n\n* Navigate to the [Releases page](https://github.com/meshtastic/c-sharp/releases) in this github repsitory\n* Download and extract the zip archive with the standalone executable for your platform\n\n![image](https://user-images.githubusercontent.com/9000580/210138838-d3aced5e-1f5b-4881-9e4d-6677d7fc94ae.png)\n\n* Execute it in the terminal of your choice (this may require security allowances or display warnings on some platforms)\n\n## Updating via dotnet cli\n\n* Execute `dotnet tool update Meshtastic.Cli -g` in your terminal of choice\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeshtastic%2Fc-sharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeshtastic%2Fc-sharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeshtastic%2Fc-sharp/lists"}