Files
2026-07-13 10:14:51 +00:00

168 lines
6.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
> [English](./README.en.md) · [原始项目](https://github.com/nexmoe/VidBee) · [上游 README](https://github.com/nexmoe/VidBee/blob/HEAD/README.md)
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
<div align="left">
<a href="https://github.com/nexmoe/VidBee">
<img src="apps/desktop/build/icon.png" alt="Logo" width="80" height="80">
</a>
<h3>VidBee</h3>
<p>
<a href="https://github.com/nexmoe/VidBee/stargazers"><img src="https://img.shields.io/github/stars/nexmoe/VidBee?color=ffcb47&labelColor=black&logo=github&label=Stars" /></a>
<a href="https://github.com/nexmoe/VidBee/graphs/contributors"><img src="https://img.shields.io/github/contributors/nexmoe/VidBee?ogo=github&label=Contributors&labelColor=black" /></a>
<a href="https://github.com/nexmoe/VidBee/releases"><img src="https://img.shields.io/github/downloads/nexmoe/VidBee/total?color=369eff&labelColor=black&logo=github&label=Downloads" /></a>
<a href="https://github.com/nexmoe/VidBee/releases/latest"><img src="https://img.shields.io/github/v/release/nexmoe/VidBee?color=369eff&labelColor=black&logo=github&label=Latest%20Release" /></a>
<a href="https://x.com/intent/follow?screen_name=nexmoex"><img src="https://img.shields.io/badge/Follow-blue?color=1d9bf0&logo=x&labelColor=black" /></a>
<a href="https://deepwiki.com/nexmoe/VidBee"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
<br />
<br />
<a href="https://github.com/nexmoe/VidBee/releases/latest" target="_blank"><img src="screenshots/main-interface.png" alt="VidBee Desktop" width="46%"/></a>
<a href="https://github.com/nexmoe/VidBee/releases/latest" target="_blank"><img src="screenshots/download-queue.png" alt="VidBee Download Queue" width="46%"/></a>
<br />
<br />
</p>
</div>
VidBee 是一款现代化的开源视频下载器,可让你从全球 1000+ 个网站下载视频和音频。基于 Electron 构建,并由 yt-dlp 驱动,VidBee 提供简洁直观的界面以及强大的下载功能,满足你的各类下载需求,包括 RSS 自动下载自动化——可自动订阅订阅源,并在后台从你喜爱的创作者处下载新视频。
## 👋🏻 入门指南
VidBee 目前仍在积极开发中,欢迎就遇到的任何 [issue](https://github.com/nexmoe/VidBee/issues) 提供反馈。
[📥 下载 VidBee](https://vidbee.org/download/) | [📚 文档](https://docs.vidbee.org)
> [!IMPORTANT]
>
> **为我们点 Star**,你将第一时间收到 GitHub 上的所有版本发布通知 ~
<a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=1081230042" target="_blank" style="display: block" align="left">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=1081230042&image_size=auto&color_scheme=dark" width="655" height="auto">
<img alt="nexmoe/VidBee 性能统计 - 最近 28 天" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=1081230042&image_size=auto&color_scheme=light" width="655" height="auto">
</picture>
</a>
<!-- Made with [OSS Insight](https://ossinsight.io/) -->
## ✨ 功能特性
### 🌍 全球视频下载支持
通过强大的 yt-dlp 引擎,从全球几乎任何网站下载视频。支持 1000+ 个站点,包括 YouTube、TikTok、Instagram、Twitter 等。
![VidBee 主界面](screenshots/main-interface.png)
### 🎨 一流的 UI 体验
现代化、简洁的界面,操作直观。支持一键暂停/恢复/重试、实时进度跟踪,以及完善的下载队列管理。
![VidBee 下载队列](screenshots/download-queue.png)
### 📡 RSS 自动下载
自动订阅 RSS 订阅源,并在后台从你喜爱的创作者处自动下载新视频,覆盖 YouTube、TikTok 等平台。只需配置一次 RSS 订阅,VidBee 便会自动下载新上传内容,无需手动操作,非常适合持续关注你喜爱的频道和创作者。
### 🎞️ 可配置的输出容器
可在 **Auto (MP4/MKV)**、**MP4**、**MKV**、**WebM** 或 yt-dlp 的 **Original** 默认选项之间选择,实现一键下载——再也不用纠结最终会拿到 MP4 还是 WebM。完整说明见 [Formats & Containers](https://docs.vidbee.org/formats)。
## 🌐 支持的网站
VidBee 通过 yt-dlp 支持 1000+ 个视频和音频平台。完整支持列表请访问 [https://vidbee.org/supported-sites/](https://vidbee.org/supported-sites/)
## 🧱 Web + API(支持 Docker
此 monorepo 现已包含:
- `packages/downloader-core`:共享的 yt-dlp/ffmpeg 下载核心
- `apps/api`:基于 Fastify 的 API 服务器,支持 oRPC 与 SSE 事件
- `apps/web`:使用 oRPC 的 TanStack Start Web 客户端
本地运行:
```bash
pnpm run start:web
```
该命令会同时启动 `apps/api``apps/web`
使用 Docker 运行:
```bash
docker compose up -d --build
```
使用 GitHub Container Registry 镜像运行:
```yaml
services:
api:
image: ghcr.io/nexmoe/vidbee-api:latest
environment:
VIDBEE_API_HOST: 0.0.0.0
VIDBEE_API_PORT: 3100
VIDBEE_DOWNLOAD_DIR: /data/downloads
VIDBEE_HISTORY_STORE_PATH: /data/vidbee/vidbee.db
ports:
- "3100:3100"
volumes:
- vidbee-downloads:/data/downloads
- vidbee-data:/data/vidbee
restart: unless-stopped
web:
image: ghcr.io/nexmoe/vidbee-web:latest
depends_on:
- api
ports:
- "3000:3000"
restart: unless-stopped
volumes:
vidbee-downloads:
vidbee-data:
```
停止服务:
```bash
docker compose down
```
可选环境变量(通过 `.env`):
```bash
VIDBEE_API_PORT=3100
VIDBEE_WEB_PORT=3000
VITE_API_URL=http://localhost:3100
```
## 🤝 参与贡献
欢迎加入开源社区,一起共建。更多详情请查看:
- Monorepo 应用:
- `apps/desktop`VidBee 桌面应用(Electron
- `apps/docs`:文档站点(Fumapress
- `apps/extension`:浏览器扩展(WXT
- `apps/desktop/docs/glitchtip.md`GlitchTip 与 `sentry-cli` 的桌面监控配置
- [贡献指南](./CONTRIBUTING.md)
- [DeepWiki Documentation](https://deepwiki.com/nexmoe/VidBee)
## 📄 许可证
本项目基于 MIT License 发布。详情请参阅 [`LICENSE`](LICENSE)。
## 🙏 致谢
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) - 强大的视频下载引擎
- [FFmpeg](https://ffmpeg.org/) - 用于音视频处理的多媒体框架
- [Electron](https://www.electronjs.org/) - 构建跨平台桌面应用
- [React](https://react.dev/) - UI 库
- [Vite](https://vitejs.dev/) - 下一代前端工具链
- [Tailwind CSS](https://tailwindcss.com/) - 实用优先的 CSS 框架
- [shadcn/ui](https://ui.shadcn.com/) - 精心设计的组件