CLI tools for interacting with ser2net serial consoles over TCP
Project description
tcp-serial
CLI tools for interacting with ser2net serial consoles over TCP.
Installation
uvx tcp-serial
Or install permanently:
uv tool install tcp-serial
Usage
tcp-serial COMMAND [options]
Commands
monitor — continuously monitor serial console output
tcp-serial monitor --port 3000
tcp-serial monitor --ssh user@host --remote-port 3000 --reconnect --timestamp
exec — execute a command over the serial console
tcp-serial exec --port 3000 -- ls /tmp
tcp-serial exec --port 3000 --json -- uname -a
tcp-serial exec --ssh user@host --remote-port 3000 -- cat /proc/version
uboot — interrupt autoboot and enter the U-Boot prompt
tcp-serial uboot --port 3000 --from-shell
tcp-serial uboot --port 3000 --manual-reboot
Connection Options
All commands share these connection options:
| Option | Description |
|---|---|
--host |
ser2net host (default: 127.0.0.1) |
--port |
ser2net TCP port |
--ssh |
SSH target for remote forwarding, e.g. user@host |
--remote-port |
ser2net TCP port on the SSH server |
--remote-host |
ser2net host as seen from the SSH server |
--ssh-arg |
extra argument passed to ssh (repeatable) |
--encoding |
text encoding (default: utf-8) |
--mode |
console mode: shell or uboot |
--connect-timeout |
max seconds to wait for connection (default: 5.0) |
Use exactly one of --port (direct) or --ssh + --remote-port (SSH forwarding).
Environment Variables
| Variable | Description |
|---|---|
TCP_SERIAL_SSH |
SSH target; overridden by --ssh |
TCP_SERIAL_REMOTE_PORT |
Remote port; overridden by --remote-port |
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tcp_serial-0.1.0.tar.gz
(8.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tcp_serial-0.1.0.tar.gz.
File metadata
- Download URL: tcp_serial-0.1.0.tar.gz
- Upload date:
- Size: 8.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3296089d7dc6a9bea267f56b4ae7600b477a55a195e5b480742a43c13a842c61
|
|
| MD5 |
c2daafe560c3f264ec9da5b858a1bbce
|
|
| BLAKE2b-256 |
0242cf44b345bd3611e84dd405ce52ce81a33f86ea1de3c13958e555cff8ae13
|
File details
Details for the file tcp_serial-0.1.0-py3-none-any.whl.
File metadata
- Download URL: tcp_serial-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
24101d2f1f6532a8137a935e2fa12024541047cd24393600319d63403a483866
|
|
| MD5 |
d91105845a94918464fd67fa0bcb6a6c
|
|
| BLAKE2b-256 |
f8d3d52f67a6ffd1927fcf434723f08b60d408933c5bb0592e44c2c196dc88bd
|