Skip to main content

replx

PyPI version Python 3.10+ License: MIT

replx is a CLI tool for MicroPython development. It uses a single local agent process to manage multiple CLI sessions and multiple boards in a consistent workflow.

It runs on Windows, macOS, and Linux and targets standard MicroPython 1.29 or newer, with a separate source-based legacy compatibility path for Digi XBee3 Zigbee. Hardware commands are platform-dependent; see the detailed manual's board compatibility table. Actual board testing has been completed on Raspberry Pi Pico 2 W and Waveshare ESP32-P4-WIFI6; Digi XBee3 compatibility still requires physical board validation.

What replx provides

  • Shared connection management across terminal sessions
  • Single local agent process per PC with home-scoped port persistence
  • Foreground and background board handling per session
  • Workspace-level default device configuration
  • File operations on device storage
  • Script execution, REPL access, and utility commands

Installation

pip install replx

Command summary

Connection and session

  • setup: Initialize workspace settings and register a default device.
  • scan: List available serial devices.
  • status: Show session and connection state.
  • fg: Change the foreground device for the current session.
  • whoami: Show the current foreground device.
  • disconnect: Close a device connection.
  • shutdown: Stop the agent and clear active sessions.
  • theme: Show or customize UI panel colors and box style.

Execution and interaction

  • exec (-c): Execute inline Python code on the device.
  • run: Run a local or device-side script.
  • repl: Open an interactive REPL session.
  • shell: Open a device file-system shell.

File operations

  • ls: List files and directories.
  • cat: Print file content.
  • get: Download files from device to local.
  • put: Upload files from local to device.
  • cp: Copy files or directories on device.
  • mv: Move or rename files or directories on device.
  • rm: Remove files or directories on device.
  • mkdir: Create directories on device.
  • touch: Create a file if missing; preserve existing contents.

Device management

  • usage: Show device storage usage.
  • reset: Perform a soft reset.
  • format: Format the device file system.
  • init: Run initialization scripts on device.
  • firmware: Check, download, or update firmware.

Package and build

  • mip: Search and install MicroPython packages from the official index or GitHub.
  • pkg: Search, download, and update packages.
  • mpy: Compile .py files to .mpy.

Hardware

  • gpio: Read, write, and run GPIO sequences.
  • pwm: Generate and monitor PWM signals.
  • adc: Read ADC pins and run a board-side scope UI.
  • uart: Open, write, read, and monitor UART.
  • spi: Open, write, read, and transfer SPI data.
  • i2c: Scan, read, write, and dump I2C devices.
  • i2s: Play I2S tones and capture or monitor an I2S microphone.
  • ws2812: Write pixels and regions on WS2812 LED matrices.

Connectivity

  • wifi: Manage Wi-Fi configuration and connection state.
  • ble: Manage BLE radio, scan, advertise, GATT server/client, and L2CAP.

Notes

  • scan, status, whoami, and shutdown are special commands and do not accept --port.
  • Most device commands can omit the port when a foreground or workspace default device is available.
  • The agent listens on a UDP port from 49152-65535 and stores the selected port in ~/.replx/.config as AGENT_PORT=....

License

MIT

Metadata

Release files for replx 1.30.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for replx 1.30.3
File Size Uploaded Provenance Actions
replx-1.30.3.tar.gz 446.8 kB Without provenance Details for replx-1.30.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for replx 1.30.3
File Interpreter ABI Platform Actions
replx-1.30.3-py3-none-any.whl Python 3 none any Details for replx-1.30.3-py3-none-any.whl

Total release size: 965.5 kB

Release files / replx-1.30.3.tar.gz

Download URL replx-1.30.3.tar.gz
Size 446.8 kB
Tags Source
SHA-256 checksum
How to use checksums
bc94773f643163f21c4f0b86f9a4aabb9c7ebef47e3ddaff1728b40990a1c75f
BLAKE2b-256 checksum
How to use checksums
9a3277d7ae07340569d15a118b4a15c3a125bdb4ce7ed8fbada4473eba775230
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / replx-1.30.3-py3-none-any.whl

Download URL replx-1.30.3-py3-none-any.whl
Size 518.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
37bfb7cc5ecce4769cc533a68a51f0057bea422bd9f87bad933aa9927746b93f
BLAKE2b-256 checksum
How to use checksums
d436eb41635c2063a7ae8712c5f84403d9f71e88a13a75dc3b18358d3cf7949b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Security for replx 1.30.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page