MoviePilot

简体中文 | English

Redesigned from parts of NAStool, with a stronger focus on core automation scenarios while reducing issues and making the project easier to extend and maintain.

For learning and personal communication only. Please do not promote this project on platforms in mainland China.

Release channel: https://t.me/moviepilot_channel

Key Features

• Focuses on the core media automation flow: subscriptions, search, downloads, file organization, scraping, media server refresh, and notifications.
• Uses a separated backend/frontend architecture: FastAPI for the backend and Vue 3 for the frontend.
• Connects download clients, media servers, metadata providers, message channels, plugins, workflows, and AI Agent capabilities.
• For feature details, screenshots, and product entry points, see https://movie-pilot.org

Installation and Usage

Docker is the recommended deployment model. V3 uses the dedicated jxxghp/moviepilot-v3 image; V2 and legacy images keep their existing names. Compose examples, environment variables, volume mappings, and upgrade notes are maintained in the official wiki:

• Official wiki: https://wiki.movie-pilot.org
• PostgreSQL setup: docs/postgresql-setup.md

MoviePilot can also be installed and managed from source with the local CLI:

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

After installation, use the moviepilot command for initialization, service management, updates, and configuration. See docs/cli.md for the full command reference.

Agent

1. MoviePilot includes a built-in AI Agent. After model configuration, it can call system tools through natural language to help with search, subscriptions, downloads, organization, diagnostics, and other management tasks.

2. Other agents can import the repository skills/ directory to gain MoviePilot operation capabilities. Environments that support the skills CLI can use:

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

   Built-in skills live in skills/. For custom skill authoring, see skills/create-moviepilot-skill/SKILL.md.

3. Other MCP clients can call MoviePilot tools through /api/v1/mcp. Authentication, client configuration, and tool APIs are documented in docs/mcp-api.md.

Development

Before contributing, read the repository rules and local environment guide, keep changes focused, and validate them before opening a PR. Useful entry points:

• Rule index: docs/rules/README.md
• Development setup and local source run: docs/development-setup.md
• Testing guide: docs/testing.md
• Site API integration requirements (Chinese): docs/site-api-integration.md, covering API capabilities, authentication, fields, and integration acceptance criteria for site developers.
• New site adapter capture and Feature Request submission: MoviePilot-Site-Collector
• Site collector downloads: independent repository Release, published only when collector inputs change.
• REST API documentation: https://api.movie-pilot.org
• Plugin development guide: https://wiki.movie-pilot.org/zh/plugindev

Related Projects

• MoviePilot-Frontend
• MoviePilot-Resources
• MoviePilot-Plugins
• MoviePilot-Server
• MoviePilot-Rust
• MoviePilot-Wiki

Disclaimer

• This software is for learning and personal communication only. It must not be used for commercial purposes or illegal activities. The software does not know how users choose to use it, and all responsibility rests with the user.
• The source code is open source and derived from other open-source code. If someone removes the relevant restrictions and redistributes or publishes modified versions that lead to liability events, the publisher of those modifications bears full responsibility. Public releases that bypass or alter the user authentication mechanism are not recommended.
• This project does not accept donations and has not published any donation page anywhere. The software itself is free of charge and does not provide paid services. Please verify information carefully to avoid being misled.

Contributors