README_CN.md

ToolKit: 用户友好的IoT协议客户端命令行工具🔧

Toolkit 是一款支持多种物联网协议的客户端命令行工具。目前支持CoAP、MQTT和NB-IoT(电信AEP平台、移动OneNET平台)协议， 未来将支持更多的协议。现代化的设计，提供自动补全、多语言配置且用户交互良好且易于操作。可在linux、unix和windows等操作系统中运行。

📖 English Document | 📖 中文文档

---

特性

🎼 集成多种IoT协议 支持MQTT、CoAP和NB-IoT协议，未来会支持更多协议， 更详细的协议打印信息；	👀 多操作系统支持 可在linux、unix、windows和树莓派上运行；	🌏 国际化服务 多语言配置，中文、英文、德语和法语支持；
💓 ANSI颜色和样式帮助 颜色使命令输出看起来好看，将重要元素与其余部分进行对比， 减少用户认知负荷；	👥 现代化的设计 提供自动补全，用户交互良好且易于操作。	💯 低内存占用和更快的启动速度 静态编译运行避免JIT的CPU开销。使用native image，提供了较快的vm性能和启动速度， 无需依赖任何运行环境

快速开始

MacOS && Linux

HOMEBREW 安装

brew install iot-technology/tap/toolkit

SDKMAN安装

安装SDKMAN!, 请看安装文档

sdk install toolkit

Windows

Chocolatey安装

安装Chocolatey, 请看安装教程

choco install toolkit

直接安装

Platform	Toolkit
Linux-x86_64	toolkit-latest-linux-x86_64.zip
Linux-arm64	toolkit-latest-linux-aarch_64.zip
Unix	toolkit-latest-osx-x86_64.zip
Windows	toolkit-latest-windows-x86_64.zip

多语言设置

设置语言为德语，支持

• zh=中文

• de=德语

• en=英语

• fr=法语

toolkit config -l=de 

IoT协议

CoAP

toolkit-coap.mp4

➜  ~ tookit coap -h
CoAP 客户端工具包
Usage: toolkit coap [-h] [COMMAND]
用户友好的CoAP协议客户端工具包

选项:
  -h, --help   显示帮助信息.
Commands:
  describe, desc   CoAP协议的介绍和描述
  media-types, mt  支持的媒体类型列表
  discover, disc   列出可用的资源
  get              从CoAP资源请求资源
  post             创建/更新CoAP资源中的数据
  put              更新CoAP资源中的数据
  delete, del      删除CoAP资源

MQTT

toolkit-mqtt.mp4

➜  ~ toolkit mqtt -h
MQTT 客户端工具包
Usage: toolkit mqtt [-h] [COMMAND]
用户友好的MQTT协议客户端工具包

选项:
  -h, --help   显示帮助信息.
Commands:
  describe, desc  MQTT协议的介绍和描述
  settings, set   MQTT设置信息管理
  publish, pub    向代理发布消息
  subscribe, sub  从MQTT Broker(代理)订阅更新

Copyright (c) 2019-2023, 物联网技术指南
Developed by mushuwei

NB-IoT

toolkit-aep-normal.mp4

➜  ~ toolkit nb -h
NB-IoT 客户端工具包
Usage: toolkit nb [-h] [COMMAND]
用户友好的 NB-IoT 客户端工具包

选项:
  -h, --help   显示帮助信息.
Commands:
  call            nb-iot 调用入口
  settings, set   nb-iot 配置信息管理
  describe, desc  nb-iot 介绍和描述

贡献

可以通过解决现有的Issues和 Pull Requests来踏入贡献Toolkit的第一步。如果您想请求一个特性或者报告bug，请使用提供的模版之一创建GitHub Issue。

Contributors

这个项目的存在要感谢所有做出贡献的人。[贡献者].

License

IoT Toolkit 使用Apache 2.0许可. 详情可看: LICENSE.

Who is using

这些只是使用 IoT Toolkit 的公司的一部分，仅供参考。如果您正在使用IoT Toolkit, 请在add your company here 告诉我们你的方案，使IoT Toolkit更好.