Serial is a modern command-line serial port tool designed with both humans and machines in mind.
Work in progress, assume everything broken.
| CI | Notes | Status |
|---|---|---|
| GitHub Actions | Very basic checks only |   |
| Azure DevOps | Actual artifacts generation happens here | |
| GitLab CI | For continuously testing GitLab's broken CI design |   |
| Coveralls | Test coverage is an illusion |  |
- Works entirely under CLI, no GUI required (even on Windows)
Please use the in-program help system for a detailed list of the options available.
serial list --format=tableThe command output looks like this:
+---+-----------+----------------------------+------+------+------+-----------+
| | PATH | DISPLAY NAME | USB? | VID | PID | SERIAL |
+---+-----------+----------------------------+------+------+------+-----------+
| 1 | \\.\COM1 | Communications Port (COM1) | No | | | |
| 2 | \\.\COM2 | Communications Port (COM2) | No | | | |
| 3 | \\.\COM5 | USB Serial Device (COM5) | Yes | 05A6 | 0009 | |
| 4 | \\.\COM7 | USB-SERIAL CH340 (COM7) | Yes | 1A86 | 7523 | |
| 5 | \\.\COM11 | USB Serial Port (COM11) | Yes | 0403 | 6010 | FTD114514 |
+---+-----------+----------------------------+------+------+------+-----------+
Machine-readable formats ('\0'-separated strings, JSON, CSV) are also available.
For *nix, specify the filename:
serial open --baudrate=115200 /dev/ttyUSB0For Windows, use either:
serial open --baudrate=115200 COM5
serial open --baudrate=115200 \\.\COM5You can use it as a "green software": just run the executable.
(TBD.)
This project adheres to Golang standard project layout. If you want to build the program yourself, use the state-of-the-art building process.
For building production binaries, use the script located in contrib/build. Refer to the CI configurations for how to
use it.
The program ("serial") is licensed under GPLv3. Dual licensing options and commercial support are available if required.
