Skip to main content

replx is a fast, modern MicroPython CLI: turbo REPL, robust file sync (put/get), project install, mpy-cross integration, and smart port discovery.

Project description

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.

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.

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 an empty file or update timestamps.

Device management

  • usage: Show device storage usage.
  • reset: Perform a soft reset.
  • format: Format the device file system.
  • init: Run initialization scripts on device.
  • wifi: Manage Wi-Fi configuration and status.
  • firmware: Check, download, or update firmware.

Package and build

  • 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.

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

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

replx-1.10.18.tar.gz (399.0 kB view details)

Uploaded Source

Built Distribution

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

replx-1.10.18-py3-none-any.whl (473.4 kB view details)

Uploaded Python 3

File details

Details for the file replx-1.10.18.tar.gz.

File metadata

  • Download URL: replx-1.10.18.tar.gz
  • Upload date:
  • Size: 399.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for replx-1.10.18.tar.gz
Algorithm Hash digest
SHA256 f38483b332dd27744842751046e46420fd9c3c40c53c091638f8a5b117f02027
MD5 2902c93377484fd26c470adfbadb9d92
BLAKE2b-256 84a2af365cf8e910e781979a4da2ee1fff651660259e21dfd50db869c3e300bc

See more details on using hashes here.

File details

Details for the file replx-1.10.18-py3-none-any.whl.

File metadata

  • Download URL: replx-1.10.18-py3-none-any.whl
  • Upload date:
  • Size: 473.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for replx-1.10.18-py3-none-any.whl
Algorithm Hash digest
SHA256 c0e5381bf68f3dee5d98762c3449daf85686e6c1b0dd5a6d523b6f808832cc1c
MD5 fe5f60371dea165bec76a23eec18965a
BLAKE2b-256 167287d6ae6c5e94525b04b328e5ad1040fa1d307fdf52e5aab75e2f95129779

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