Koel项目CLI命令完全指南

Koel项目CLI命令完全指南

koel 项目地址: https://gitcode.com/gh_mirrors/koe/koel

Koel作为一个现代化的音乐流媒体服务器，提供了丰富的命令行工具来简化系统管理和维护工作。本文将全面解析Koel内置的CLI命令，帮助管理员高效地管理系统。

命令概览

Koel基于Laravel框架开发，所有命令都通过artisan命令行工具执行。要查看所有可用命令，可以执行：

php artisan list | grep koel

这条命令会过滤出所有Koel相关的命令，包括系统初始化、用户管理、媒体库扫描等核心功能。

核心命令详解

1. 系统初始化命令

koel:init是Koel最重要的命令之一，用于初始安装或升级系统：

php artisan koel:init

可选参数--no-assets可以跳过前端资源编译，这在开发环境中很有用。

2. 用户管理命令

koel:admin:change-password允许管理员修改用户密码：

php artisan koel:admin:change-password user@example.com

如果不指定邮箱参数，将修改默认管理员账户的密码。

3. 授权管理命令组

Koel Plus版本提供三个授权相关命令：

• koel:license:activate <key> - 激活授权
• koel:license:deactivate - 停用当前授权
• koel:license:status - 查看授权状态

4. 媒体库管理命令

koel:scan是最常用的命令之一，用于扫描音乐目录：

php artisan koel:scan --owner=1 --private --ignore=lyrics,cover

重要参数说明：

• --owner：指定音乐文件所属用户ID
• --private：将扫描的音乐设为私有
• --ignore：忽略指定的元数据标签
• --force：强制重新扫描所有文件

koel:prune命令可以清理空的艺术家和专辑记录：

php artisan koel:prune

5. 存储配置命令组

Koel支持多种存储后端，相关配置命令包括：

• koel:storage - 交互式存储配置向导
• koel:storage:local - 配置本地存储
• koel:storage:s3 - 配置Amazon S3存储
• koel:storage:dropbox - 配置Dropbox存储

高级功能命令

播客同步

koel:podcasts:sync命令用于同步播客内容：

php artisan koel:podcasts:sync

搜索索引

koel:search:import命令重建搜索索引：

php artisan koel:search:import

元数据收集

koel:tags:collect是遗留命令，用于收集额外的音乐标签信息：

php artisan koel:tags:collect

命令调度最佳实践

Koel推荐使用Laravel的任务调度系统来定期执行维护命令。在crontab中添加：

* * * * * cd /path-to-koel && php artisan schedule:run >> /dev/null 2>&1

默认调度配置：

• 每日午夜执行koel:scan
• 每日午夜执行koel:prune
• 每日午夜执行koel:podcasts:sync

使用技巧

1. 获取命令帮助信息：

php artisan 命令名 -h

2. 开发环境下跳过资源编译：

php artisan koel:init --no-assets

3. 强制重新扫描媒体库：

php artisan koel:scan --force

通过合理利用这些CLI命令，管理员可以轻松完成Koel系统的日常维护工作，确保音乐服务稳定运行。

koel 项目地址: https://gitcode.com/gh_mirrors/koe/koel