Command deck

Plundarr and Maraudarr

Most deployment targets accept PRESET=YOUR-PRESET. Omit it for the default plundarr project.

Command	Purpose
make ship	Generate the default Plundarr project under dist/plundarr/.
make ship PRESET=YOUR-PRESET	Generate one named preset under dist/YOUR-PRESET/.
make configure	Open Maraudarr's interactive preset and service picker.
make pull-image	Pull the configured published Maraudarr image.
make presets	List presets and their default services.
make services	List every selectable service.
make compose-services PRESET=YOUR-PRESET	List services in an existing generated Compose project.
make config PRESET=YOUR-PRESET	Render and validate the generated Compose model.
make env PRESET=YOUR-PRESET	Print evaluated environment values.
make up PRESET=YOUR-PRESET	Build, create, and start the selected project.
make down PRESET=YOUR-PRESET	Stop the project while preserving volumes, images, environment, config, and backups.
make ps PRESET=YOUR-PRESET	Print compact service status.
make logs PRESET=YOUR-PRESET	Follow the selected project logs.
make backup PRESET=YOUR-PRESET	Archive the host config tree; export databases and named-volume backups first.
make watchtower-run-once PRESET=watchtower	Run one host-wide Watchtower update pass.
make kometa-overlay-reset PRESET=duplex	Run the profile-gated overlay repair tool.
make recyclarr-preview PRESET=plundarr	Preview the selected Recyclarr configuration without applying it.
make recyclarr-sync PRESET=plundarr	Apply the reviewed configuration to Radarr and Sonarr.
make clean	Remove disposable developer artifacts without touching deployments or Docker resources.
make test-unit	Run Maraudarr unit tests.
make test	Run the generator, strict Python types, policy, workflow, and preset matrix checks.
make test-types	Run the pinned strict Python checker in a disposable test image.
make test-vpn	Validate an already-running VPN and downloader lane.
make test-e2e	Launch and validate the focused live VPN path.
make test-image	Test the hardened Maraudarr image.
make build-platforms	Validate Maraudarr on every published architecture.
make docs	Build Plundarr's strict developer documentation.
make docs-serve	Preview Plundarr's developer documentation.

Select overlay-reset or recyclarr before invoking its tool target. See v2 command replacements for older scripts and Tracearr backup exports before relying on a config archive.

The published Plundarr developer documentation covers Maraudarr architecture, extension contracts, testing, and the generated Python reference.

Caution

make nuke PRESET=YOUR-PRESET removes attributable Docker resources but preserves deployment files and application state. make delete-config PRESET=YOUR-PRESET deletes the selected configuration tree. Back up the deployment before either destructive operation.

Privateerr standalone source

Use these only when you need the focused Privateerr repository outside Plundarr:

Command	Purpose
make / make help	Show the command menu.
make run-privateerr	Generate fresh files once with recovery and keepalive disabled for that run.
make up / make down	Start or stop Privateerr, Gluetun, qBittorrent, and the Buccaneerr test example.
make env	Print evaluated environment values.
make config	Render the resolved Compose model.
make ps / make logs	Inspect service status or logs.
make backup	Archive the complete Privateerr configuration directory.
make restore-test-config	Restore checked-in safe example files.
make clean-test	Stop test containers and restore example state.
make clean	Remove disposable developer artifacts; leave the stack and generated VPN state alone.
make test	Run Python tests, strict types, lint, policy, and helper checks in Buccaneerr.
make test-types	Run strict Pyright checks in Buccaneerr.
make test-precommit	Run all repository hooks through Buccaneerr.
make spellcheck	Check project spelling using the VS Code vocabulary.
make docs / make docs-serve	Build or preview the developer site and Python reference.
make test-recovery-api	Test real Gluetun/qBittorrent API behavior without PIA credentials.
make test-recovery-live	Test isolated live PIA recovery and incoming TCP with local credentials.
make test-e2e	Run live Buccaneerr validation with supplied credentials.
make build-platforms	Validate both images on published architectures.

The Privateerr developer site covers the supervisor architecture, Python reference, and testing contracts. make up and make test-e2e include a deliberate VPN interruption by default; use the standalone guide for a lasting three-service deployment. Stop any supervisor sharing the output directory before one-shot generation.

Preset examples

make ship PRESET=boudoirr ADD_SERVICES=sabnzbd
make ship PRESET=jellyfin
make ship PRESET=plex
make ship PRESET=calibre-web-automated
make ship PRESET=duplex ADD_SERVICES=watchtower
make ship PRESET=watchtower
make ship PRESET=portainer

Plundarrpedia

Command	Purpose
make serve	Run the Compose live-reload authoring service.
make site	Export the strict static site into site/.
make clean	Delete the generated static site.
make build	Build the unprivileged Nginx image.
make build-multiarch	Validate every published platform.
make config	Validate the one-file Compose deployment.
make run / make down	Start or stop the production wiki stack.

Universal diagnostics

Run these from the directory containing the relevant Compose file and .env:

docker compose config
docker compose ps
docker compose logs --tail=100 SERVICE
docker inspect CONTAINER
docker network ls
git status --short