Metadata-Version: 2.4
Name: replx
Version: 1.25.0
Summary: replx is a fast, modern MicroPython CLI: turbo REPL, robust file sync (put/get), project install, mpy-cross integration, and smart port discovery.
Author-email: "chanmin.park" <devcamp@planxlab.com>
License-Expression: MIT
Project-URL: Homepage, https://planxlab.com
Project-URL: Repository, https://github.com/PlanXLab/replx
Project-URL: Issues, https://github.com/PlanXLab/replx/issues
Keywords: micropython,repl,serial,pyserial,typer,mpy-cross,deploy,gpio,i2c,spi,uart,pwm,adc,i2s,ws2812
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Hardware :: Universal Serial Bus (USB)
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.4.2
Requires-Dist: typer>=0.27.0
Requires-Dist: rich>=13.0
Requires-Dist: pyserial>=3.5
Requires-Dist: mpy-cross>=1.27.0
Requires-Dist: psutil>=7.2.2
Dynamic: license-file

# replx

[![PyPI version](https://badge.fury.io/py/replx.svg)](https://pypi.org/project/replx/)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**A cross-platform command-line toolkit for MicroPython development.** replx runs a shared local agent so multiple terminals can work with multiple boards while reusing connections and session state.

## Features

- Works on Windows, Linux, and macOS.
- Connect to multiple boards from multiple terminals, with per-session foreground and background devices.
- Discover boards, configure a workspace default, and set up VS Code MicroPython support.
- Run scripts and snippets, use the interactive REPL, and sync files and directories.
- Search and install packages with `mip` or `pkg`; compile `.py` files to `.mpy`.
- Work with GPIO, PWM, ADC, UART, SPI, I2C, I2S, BLE, and WS2812 devices (availability depends on board and firmware).
- Use MicroPython raw-paste for code submissions of 4 KiB or larger when supported; batched file uploads keep the standard raw path for throughput.

## Install

```sh
python -m pip install replx
```

This installs both `replx` and the `rx` command.

## Quick start

```sh
replx scan
replx COM4 setup
replx status
replx -c "print('Hello from MicroPython')"
replx run main.py
replx repl
```

Replace `COM4` with the board's serial port, such as `/dev/ttyUSB0` on Linux or `/dev/cu.usbmodem14101` on macOS. After `setup`, the configured board can usually be targeted without repeating the port; specify a port when working with another board.

## Documentation

This PyPI page is a short overview and quick start. See the [full command reference and user manual on GitHub](https://github.com/PlanXLab/replx) for connection/session behavior, commands, options, examples, and troubleshooting.

- [GitHub repository](https://github.com/PlanXLab/replx)
- [Report an issue](https://github.com/PlanXLab/replx/issues)
- [Website](https://planxlab.com)
