MoviePilot README

The project's README from github.com/jxxghp/MoviePilot. As one markdown file: README.md.

MoviePilot

简体中文 | English

GitHub Repo stars GitHub forks GitHub contributors GitHub repo size GitHub issues Docker Pulls Docker Pulls V2 Docker Pulls V3 Platform

基于 NAStool 部分代码重新设计,聚焦自动化核心需求,减少问题同时更易于扩展和维护。

仅用于学习交流使用,请勿在任何国内平台宣传该项目!

发布频道:https://t.me/moviepilot_channel

主要特性

安装使用

推荐优先使用 Docker 部署。V3 使用独立镜像 jxxghp/moviepilot-v3,V2 和旧版镜像保持原命名。Compose 示例、环境变量、目录映射和升级方式以官方 Wiki 为准:

也可以使用本地 CLI 以源码模式安装和管理 MoviePilot:

curl -fsSL https://raw.githubusercontent.com/jxxghp/MoviePilot/v3/scripts/bootstrap-local.sh | bash

安装完成后使用 moviepilot 命令完成初始化、启动、停止、更新和配置查看。完整命令见 docs/cli.md。

Agent

  1. MoviePilot 自带智能体能力,可在完成模型配置后,通过自然语言调用系统工具,辅助完成搜索、订阅、下载、整理、排障等管理任务。

  2. 其它智能体可以导入本仓库的 skills/ 目录以获得 MoviePilot 操作能力;支持 skills CLI 的环境可使用:

    npx skills add https://github.com/jxxghp/MoviePilot
    

    内置 Skills 列表见 skills/,自定义 Skill 可参考 skills/create-moviepilot-skill/SKILL.md。

  3. 其它 MCP 客户端可以通过 MoviePilot 的 MCP 端点 /api/v1/mcp 调用工具,认证方式、客户端配置和工具 API 见 docs/mcp-api.md。

参与开发

开发前请先阅读仓库规则和本地环境说明,保持变更聚焦,通过测试后再提交 PR。常用入口:

相关项目

免责申明

贡献者

MoviePilot (jxxghp/MoviePilot)

media-server
Searching Database…

What is this?MoviePilot is a self-hosted automation tool for managing a NAS media library. It handles the whole movie/TV workflow — subscribing, searching, downloading, organizing, scraping metadata, refreshing media servers, and sending notifications.
Is this a desktop app or a web service I run on my NAS?It's a self-hosted web application with a separated architecture: a FastAPI backend and a Vue 3 frontend, meant to run continuously on a NAS or server, not a local desktop program.
How do I install and run MoviePilot?Docker is the recommended way: V3 uses its own image jxxghp/moviepilot-v3 (older V2 keeps the original image name), with Compose examples and environment variables documented on the official Wiki. You can also install from source and manage it with the local `moviepilot` CLI (init, start, stop, update, config).
Do I need a download client or media server already set up?Yes — MoviePilot is a hub that connects to external downloaders, media servers, metadata sources, and notification channels, plus optional plugins, workflows and an AI agent. You configure those services for it to actually act on your library.
Are there any usage restrictions I should know about?The project is explicitly for learning/study only — commercial use and illegal use are disallowed, and the author asks that it not be promoted on domestic Chinese platforms. It also discourages bypassing or modifying the built-in authentication system when redistributing modified copies, shifting liability onto whoever does so.
What does the built-in Agent/AI feature do?Once a model is configured, MoviePilot's built-in AI agent can be driven with natural language to search, subscribe, download, organize and troubleshoot your library. Other agents can import the skills/ directory, and external MCP clients can connect through the /api/v1/mcp endpoint.
Where do plugins and related tools live?Plugins ship in a separate MoviePilot-Plugins repository, alongside companion projects for the frontend (MoviePilot-Frontend), shared resources (MoviePilot-Resources), a server variant (MoviePilot-Server), and a Rust reimplementation (MoviePilot-Rust).
Can I use PostgreSQL instead of the default database?Yes, PostgreSQL is a supported backend; setup steps are documented separately in docs/postgresql-setup.md.
Creator
jxxghp
Size
86.5 MB
Stars
11.9K
Age
3y
Commits · 90 Days