Getting Started¶
One command. Two minutes. Every print archived automatically.
Quick Install¶
Interactive script — handles everything for you. Requires a bash-compatible shell (Linux, macOS, or WSL on Windows):
curl -fsSL https://raw.githubusercontent.com/maziggy/bambuddy/main/install/docker-install.sh -o docker-install.sh && chmod +x docker-install.sh && ./docker-install.sh
Open Bambuddy at http://<your-host>:8000 in your browser — replace <your-host> with the IP or hostname of the machine running Bambuddy. On Linux with host networking you can use localhost; on Docker Desktop (macOS/Windows) localhost does not reach the container — use the LAN IP of the host machine instead.
The interactive install script is bash-only — Windows PowerShell doesn't have chmod. Use the manual compose flow instead:
mkdir bambuddy
cd bambuddy
Invoke-WebRequest -Uri https://raw.githubusercontent.com/maziggy/bambuddy/main/docker-compose.yml -OutFile docker-compose.yml
docker compose up -d
Open Bambuddy at http://<your-host>:8000 in your browser, replacing <your-host> with the LAN IP of the Windows machine running Docker Desktop. localhost will not work — Docker Desktop runs the container inside a Linux VM with network_mode: host, so the container is on the VM's network, not on Windows' loopback.
Interactive script — installs Python venv, builds the frontend, sets up a systemd/launchd service:
curl -fsSL https://raw.githubusercontent.com/maziggy/bambuddy/main/install/install.sh -o install.sh && chmod +x install.sh && ./install.sh
Open Bambuddy at http://<your-host>:8000 in your browser — replace <your-host> with the IP or hostname of the machine running Bambuddy, or use localhost if you're on the same machine (native installs run directly on host networking, no Docker VM in the way).
Next Steps¶
Enable Developer Mode¶
Enable Developer Mode on your printer and note the access code.
Enabling Developer Mode¶
Bambuddy connects to your printer via Developer Mode - a local connection that provides full control without internet.
Why Developer Mode?
Developer Mode provides direct communication between Bambuddy and your printer over your local network. This means:
- Works offline - No internet required
- Full control - Start/stop prints, upload files, control lights
- Your data stays local - No cloud dependency
Developer Mode vs LAN Only Mode
Since the January 2025 firmware update, standard LAN Only Mode (without Developer Mode) only provides read-only access. You can monitor your printer, but you cannot control it. Developer Mode is required for full functionality with Bambuddy.
Step 1: Enable LAN Only Mode¶
- On your printer's touchscreen, go to Settings
- Navigate to Network or WLAN
- Toggle LAN Only Mode to ON
Step 2: Enable Developer Mode¶
- After enabling LAN Only Mode, a Developer Mode option will appear
- Toggle Developer Mode to ON
- Note down the Access Code displayed (8 characters)
Access Code Changes
The access code changes every time you toggle these modes off and on. If you re-enable Developer Mode, you'll need to update the access code in Bambuddy.
Step 3: Insert SD Card¶
SD Card Required
An SD card must be inserted in your printer for Bambuddy to work properly. The SD card is required for:
- File transfers to/from the printer
- Starting prints from Bambuddy
- Archiving completed prints
Without an SD card, Bambuddy cannot transfer files or start prints on your printer.
Step 4: Enable "Store sent files on external storage"¶
Bambuddy needs the slicer to leave a copy of the .gcode.3mf on the printer's SD card so it can pull thumbnails and slicer metadata back into the archive. There are two places this setting can live, depending on your slicer + firmware combination:
- Open Bambu Studio or OrcaSlicer
- Go to the Device tab for your printer
- Enable "Store sent files on external storage"
Recent firmware/slicer releases moved the toggle out of the slicer onto the printer itself. If the option is missing in Bambu Studio's Device tab, set it on the printer:
- On the printer, open Settings Print Settings (or Print Options, depending on firmware)
- Enable the equivalent "Store sent files on external storage" option
Reported on a P2S in #1170.
Why is this needed?
Bambuddy extracts thumbnails and 3D model previews from the 3MF files on the SD card. Without this setting, every print falls back to a no-3MF archive: no thumbnail, no source 3MF, no slicer metadata.
Step 5: Gather Printer Information¶
You'll need these details to add your printer:
| Information | Where to Find |
|---|---|
| IP Address | Settings Network |
| Serial Number | Settings Device Info |
| Access Code | Shown when Developer Mode is enabled |
What's Next?