Skip to main content

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


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.2.0.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tcp_serial-0.2.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file tcp_serial-0.2.0.tar.gz.

File metadata

  • Download URL: tcp_serial-0.2.0.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.16

File hashes

Hashes for tcp_serial-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ab25fdd48fc75283ef25d1501bd8ecbbd1f0bc907f707315b60ab240e1961841
MD5 0320f7b6561e0dc9f21756255ea485b4
BLAKE2b-256 96b01852595b2f2e66ff9a7dea36474dc06e3eaeabfba6568333360deb9c8ecc

See more details on using hashes here.

File details

Details for the file tcp_serial-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: tcp_serial-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.16

File hashes

Hashes for tcp_serial-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 942ecf2b4b3b7dccf152513f7895d1d021f70543cd351483d867628b443057b6
MD5 44d78fdf808b94c7f2a8247267cefa0e
BLAKE2b-256 ccb8959d87429041b45a0a982664b2802da27545758277eb2b0961760e1123c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page