cli/README.md

44 lines
1.1 KiB
Markdown
Raw Normal View History

2020-12-26 15:44:44 +00:00
# Unlock Music Project - CLI Edition
2021-05-16 09:18:37 +00:00
2022-11-27 02:30:40 +00:00
Original: Web Edition https://git.unlock-music.dev/um/web
2021-05-16 09:18:37 +00:00
2022-11-27 02:30:40 +00:00
- [![Build Status](https://ci.unlock-music.dev/api/badges/um/cli/status.svg)](https://ci.unlock-music.dev/um/cli)
- [Release Download](https://git.unlock-music.dev/um/cli/releases/latest)
- [Latest Build](https://git.unlock-music.dev/um/-/packages/generic/cli-build/)
2020-12-26 15:44:44 +00:00
2024-10-12 20:45:25 +00:00
> **WARNING**
> 在本站 fork 不会起到备份的作用,只会浪费服务器储存空间。如无必要请勿 fork 该仓库。
2020-12-26 15:44:44 +00:00
## Features
2021-05-16 09:18:37 +00:00
2022-11-27 02:30:40 +00:00
- [x] All Algorithm Supported By `unlock-music/web`
2022-12-06 17:57:51 +00:00
- [x] Complete Metadata & Cover Image
2020-12-26 15:44:44 +00:00
## Hou to Build
2021-05-16 09:18:37 +00:00
2022-12-06 18:02:50 +00:00
- Requirements: **Golang 1.19**
2020-12-26 15:44:44 +00:00
2022-11-27 02:30:40 +00:00
1. run `go install unlock-music.dev/cli/cmd/um@master`
2020-12-26 15:44:44 +00:00
## How to use
2021-05-16 09:18:37 +00:00
- Drag the encrypted file to `um.exe` (Tested on Windows)
- Run: `./um [-o <output dir>] [-i] <input dir/file>`
2020-12-26 15:44:44 +00:00
- Use `./um -h` to show help menu
## Update CI pipeline
Ensure `jsonnet` and `yq` is installed.
```sh
# Debian / Ubuntu etc:
sudo apt install jsonnet yq
```
1. Edit `.drone.jsonnet`
2. Update drone CI pipeline:
```sh
jsonnet .drone.jsonnet | yq -y > .drone.yml
```