# x-tools

**Repository Path**: x-tools-author/x-tools

## Basic Information

- **Project Name**: x-tools
- **Description**: Qt-串口-UDP-TCP-WebSocket-Modbus-CANBus-BLE-调试助手（支持自定义Lua脚本）
- **Primary Language**: C++
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: https://x-tools-author.github.io/x-tools/
- **GVP Project**: No

## Statistics

- **Stars**: 613
- **Forks**: 262
- **Created**: 2020-03-13
- **Last Updated**: 2025-09-29

## Categories & Tags

**Categories**: devtools

**Tags**: TCP, WebSocket, Qt, udp, 串口

## README

# xTools ![CodeSize](https://img.shields.io/github/languages/code-size/x-tools-author/x-tools) ![RepoSize](https://img.shields.io/github/repo-size/x-tools-author/x-tools) [![Static Badge](https://img.shields.io/badge/sponsor-Microsoft_Sotre-blue)](https://apps.microsoft.com/detail/9p29h1ndnkbb) [![build-apps](https://github.com/x-tools-author/x-tools/actions/workflows/build-apps.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-apps.yml) [![build-daily](https://github.com/x-tools-author/x-tools/actions/workflows/build-daily.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-daily.yml)

[![build-windows](https://github.com/x-tools-author/x-tools/actions/workflows/build-windows.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-windows.yml)
[![build-ubuntu](https://github.com/x-tools-author/x-tools/actions/workflows/build-ubuntu.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-ubuntu.yml)
[![build-macos](https://github.com/x-tools-author/x-tools/actions/workflows/build-macos.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-macos.yml)
[![build-android](https://github.com/x-tools-author/x-tools/actions/workflows/build-android.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-android.yml)
[![build-qt5](https://github.com/x-tools-author/x-tools/actions/workflows/build-qt5.yml/badge.svg)](https://github.com/x-tools-author/x-tools/actions/workflows/build-qt5.yml)

[![Packaging status](https://repology.org/badge/vertical-allrepos/x-tools.svg)](https://repology.org/project/x-tools/versions)

*xTools* is a user-friendly, open-source, cross-platform, easily extendable(using Lua and JavaScript) debugging tool-set based on Qt (Qt6.8 is recommended). It offers extensive support for serial port, HID, BLE, UDP, TCP, web socket, Modbus and CAN Bus debugging functionalities.

> [!WARNING]
> Qt 6.9.2 is required to build xTools on macOS 26.0(and later). Qt 6.8(Other will be nice but is not test) is required to build for Android platform.

>[!NOTE]
> You can get *xTools* form [Micorsoft Store(sponsor)](https://apps.microsoft.com/detail/9p29h1ndnkbb) or from [Github Release(community)](https://github.com/x-tools-author/x-tools/releases).

## Build

### Arch Linux

Arch Linux can install x-tools via the [AUR](https://aur.archlinux.org/packages/x-tools) or a [self-built source](https://github.com/taotieren/aur-repo).

```bash
yay -Syu x-tools
```

## Dark theme

![xToolsDark.png](res/images/dark.png)

## Light theme

![xToolsLight.png](res/images/light.png)

<details>

<summary>🖼️More Screenshots</summary>

<!-- https://github.com/ikatyang/emoji-cheat-sheet/blob/github-actions-auto-update/README.md -->

![xTools.gif](res/images/gif.gif)
![xTools.gif](res/images/xtools.gif)
![charts.gif](res/images/charts.gif)
![search.gif](res/images/search.png)
![lua.png](docs/assets/images/lua.png)
![js.png](docs/assets/images/js.png)

</details>

## Other

<!--https://sdpro.top/blog/html/article/1016.html-->
[![stars](https://img.shields.io/github/stars/x-tools-author/x-tools?style=social)](https://img.shields.io/github/stars/x-tools-author/x-tools?style=social)
[![forks](https://img.shields.io/github/forks/x-tools-author/x-tools?style=social)](https://img.shields.io/github/forks/x-tools-author/x-tools?style=social)
[![watchers](https://img.shields.io/github/watchers/x-tools-author/x-tools?style=social)](https://img.shields.io/github/watchers/x-tools-author/x-tools?style=social)
[![star](https://gitee.com/x-tools-author/x-tools/badge/star.svg?theme=dark)](https://gitee.com/x-tools-author/x-tools/stargazers)
[![fork](https://gitee.com/x-tools-author/x-tools/badge/fork.svg?theme=dark)](https://gitee.com/x-tools-author/x-tools/members)

|Option|Description|
|---|---|
|Author|x-tools-author|
|E-mail|<x-tools@outlook.com>|
|User Communication| 952218522 (QQ Group)|
|Qt Technology Communication|723516989 (QQ Group)|
|Gitee| <https://gitee.com/x-tools-author/x-tools>|
|GitHub| <https://github.com/x-tools-author/x-tools>|
|Sponsor|<https://apps.microsoft.com/search/publisher?name=x-tools-author>|
|Third party|[lua](https://github.com/lua/lua) [zint](https://github.com/zint/zint) [glog](https://github.com/google/glog) [libqrencode](https://github.com/fukuchi/libqrencode) [qmdnsengine](https://github.com/nitroshare/qmdnsengine) [QXlsx](https://github.com/QtExcel/QXlsx) [hidapi](https://github.com/libusb/hidapi) [libiconv](https://ftp.gnu.org/pub/gnu/libiconv) [SingleApplication](https://github.com/itay-grudev/SingleApplication)|