cli/README.md

27 lines
773 B
Markdown
Raw Normal View History

2020-12-26 23:44:44 +08:00
# Unlock Music Project - CLI Edition
2021-05-16 17:18:37 +08:00
2022-11-27 10:30:40 +08:00
Original: Web Edition https://git.unlock-music.dev/um/web
2021-05-16 17:18:37 +08:00
2022-11-27 10:30:40 +08: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 23:44:44 +08:00
## Features
2021-05-16 17:18:37 +08:00
2022-11-27 10:30:40 +08:00
- [x] All Algorithm Supported By `unlock-music/web`
2020-12-26 23:44:44 +08:00
- [ ] Complete Cover Image
- [ ] Parse Meta Data
- [ ] Complete Meta Data
## Hou to Build
2021-05-16 17:18:37 +08:00
2021-11-11 23:18:17 +08:00
- Requirements: **Golang 1.17**
2020-12-26 23:44:44 +08:00
2022-11-27 10:30:40 +08:00
1. run `go install unlock-music.dev/cli/cmd/um@master`
2020-12-26 23:44:44 +08:00
## How to use
2021-05-16 17:18:37 +08:00
- Drag the encrypted file to `um.exe` (Tested on Windows)
- Run: `./um [-o <output dir>] [-i] <input dir/file>`
2020-12-26 23:44:44 +08:00
- Use `./um -h` to show help menu