Chinese Simplified | English

Redesigned based on part of NAStool code, focusing on core automation needs, reducing issues while making scalability and maintenance easier.

For study and communication purposes only. Do not promote this project on any domestic platform!

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

Main Features

• Focuses on core processes of film automation: subscription, search, download, organize, scrape, refresh the media library, and message notifications.
• Front-end and back-end separation: backend based on FastAPI, frontend based on Vue 3, with clearer boundaries between deployment and expansion.
• Supports a combination of capabilities including downloaders, media servers, metadata sources, messaging channels, plugins, workflows, and AI Agents.
• For a more complete feature introduction, screenshots, and user interface, see the official website: https://movie-pilot.org

Installation and Use

It is recommended to prioritize Docker deployment. V3 uses standalone images jxxghp/moviepilot-v3; V2 and older images retain their original names. Compose examples, environment variables, directory mapping, and upgrade methods are based on the official wiki:

• Official Wiki:https://wiki.movie-pilot.org
• Overview of changes from V2 to V3: docs/v2-to-v3-overview.md
• PostgreSQL deployment instructions: docs/postgresql-setup.md

You can also install and manage MoviePilot in source mode using the local CLI:

After installation, use the moviepilot command to initialize, start, stop, update, and configure the settings. For the full command, see docs/cli.md.

Agent

1. MoviePilot comes with built-in agent capabilities. After completing model configuration, it can use natural language call system tools to assist with management tasks such as search, subscription, download, organization, and troubleshooting.
2. Other agents can import the skills/ directory of this repository to obtain MoviePilot operation capabilities; Environments supporting the skills CLI can be used:

For the list of built-in skills, see skills/; for custom skills, refer to skills/create-moviepilot-skill/SKILL.md. 3. Other MCP clients can invoke tools via MoviePilot’s MCP endpoint /api/v1/mcp. For authentication methods, client configuration, and tool APIs, see docs/mcp-api.md.

Participate in development

Before development, please read the repository rules and local environment instructions, stay focused on changes, and only submit PRs after passing testing. Common entry points:

• Document rule entry point: docs/rules/README.md
• Development environment and local source code run: docs/development-setup.md
• Test instructions: docs/testing.md