moviepilot-update ยท diff
v3 to v4
26 added, 13 removed. Audit A to A.
---
name: moviepilot-update
- version: 3
- description: Use this skill when you need to check MoviePilot versions, restart MoviePilot, or trigger a MoviePilot upgrade. Prefer the built-in system APIs instead of docker commands or manual file replacement. If auto-update on restart is already enabled, just restart. If it is disabled, call the upgrade API so MoviePilot performs a one-shot upgrade and restart.
+ version: 4
+ description: Use this skill to check MoviePilot versions, inspect Release update state, download a Release update in the background, confirm installation, restart MoviePilot, or retain the existing Dev branch update flow. Prefer the built-in system APIs instead of container commands or manual file replacement.
---
# MoviePilot Update
> All script paths are relative to this skill file.
Use this skill for MoviePilot restart and upgrade operations.
## Setup
This skill reuses the `moviepilot-api` client. When running inside the MoviePilot project, the API client imports `app.runtime.config.settings` and reads the local host, port, and API token directly. Do not ask the user for `API_TOKEN`.
## Preferred Commands
### Check versions
```bash
python scripts/mp-update.py versions
```
This calls `GET /api/v1/system/versions`.
### Restart MoviePilot
```bash
python scripts/mp-update.py restart
```
This calls `GET /api/v1/system/restart`.
- ### Upgrade and restart MoviePilot
+ ### Release update
- Release mode:
+ Check for a stable Release and inspect current progress:
```bash
- python scripts/mp-update.py upgrade
+ python scripts/mp-update.py check
+ python scripts/mp-update.py status
```
- Dev mode:
+ Start the background download. This does not restart MoviePilot:
```bash
- python scripts/mp-update.py upgrade dev
+ python scripts/mp-update.py download
```
- This calls `POST /api/v1/system/upgrade`.
+ After `status` reports `state=ready`, installation requires a separate explicit confirmation:
- Behavior:
+ ```bash
+ python scripts/mp-update.py install
+ ```
- - If `MOVIEPILOT_AUTO_UPDATE` is already enabled (`release` or `dev`), MoviePilot only triggers a restart and lets the normal startup flow perform the upgrade.
- - If `MOVIEPILOT_AUTO_UPDATE` is disabled, MoviePilot writes a one-shot upgrade flag, restarts itself, performs that single upgrade during startup, and then continues running without changing the persisted auto-update setting.
+ `install` writes the verified install intent and restarts MoviePilot. Do not call it until the user explicitly confirms the restart.
+ ### Dev update and restart
+
+ ```bash
+ python scripts/mp-update.py upgrade dev
+ ```
+
+ Dev mode retains the existing `POST /api/v1/system/upgrade` path with body `"dev"`. It tracks the current v3 development branch during restart. Release mode is no longer accepted by that endpoint.
+
## Direct API Examples
```bash
python ../moviepilot-api/scripts/mp-api.py GET /api/v1/system/restart
- python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/upgrade --json '"release"'
+ python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/update/check
+ python ../moviepilot-api/scripts/mp-api.py GET /api/v1/system/update/status
+ python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/update/download
+ python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/update/install
python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/upgrade --json '"dev"'
```
## Notes
- These operations require administrator authentication.
- - Restart or upgrade will interrupt the current agent session. Do not rely on post-restart follow-up steps in the same run.
+ - Only restart, Release installation, and Dev upgrade interrupt the current agent session. Checking and downloading remain online.
- Prefer the API flow above. Only fall back to manual container commands when the API is unavailable.