name: managing-circuitpython-libraries
description: Manages CircuitPython libraries using circup CLI. Use when installing, updating, or managing libraries on a CircuitPython device.

Managing CircuitPython Libraries with circup

Use the circup CLI tool to manage libraries on connected CircuitPython devices.

Prerequisites

• Python 3.5+ installed
• circup installed: pip3 install --user circup
• CircuitPython device connected (mounted as CIRCUITPY)

Common Commands

View installed libraries

circup show

Check for updates

circup list

Update all outdated libraries

circup update

Install specific library

circup install <library_name>

Example:

circup install adafruit_neopixel
circup install adafruit_bus_device adafruit_register

Auto-install from code.py imports

circup install --auto

Install from requirements.txt

circup install -r requirements.txt

Export installed libraries to requirements.txt

circup freeze -r

Uninstall a library

circup uninstall <library_name>

Search for libraries

circup show <search_term>

Example:

circup show bme

Flags

Workflow: Setting Up a New Device

1. Connect device (should mount as CIRCUITPY)
2. Auto-install dependencies: circup install --auto
3. Or install specific libraries: circup install <lib1> <lib2>
4. Verify: circup show

Workflow: Keeping Libraries Updated

1. Check for updates: circup list
2. Update all: circup update

Multiple Devices

Use --path to target a specific device:

circup --path /Volumes/CIRCUITPY2 install adafruit_neopixel

Library Sources

circup pulls from:
- Adafruit CircuitPython Bundle
- CircuitPython Community Bundle