ahdoawhfo/cli
1
0
Fork 0
mirror of https://git.um-react.app/um/cli.git synced 2026-10-19 21:18:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add comprehensive agent guide for um-cli, detailing architecture, commands, and conventions

Browse Source
This commit is contained in:
鲁树人
2026-10-18 08:28:55 +09:00
parent 1028a1f2be
commit bdb68efbb9
3 changed files with 191 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.cursor/rules/um-cli.mdc
+13
View File
@@ -0,0 +1,13 @@
---
description: um-cli (Unlock Music CLI) project conventions for agents
alwaysApply: true
---
# um-cli
- Module: `git.um-react.app/um/cli`. Entry: `cmd/um/main.go`. Read `AGENTS.md` before structural changes.
- Decoders live under `algo/<vendor>/`, register via `common.RegisterDecoder` in `init()`, blank-import new packages from `cmd/um`.
- Shared non-algo code goes in `internal/`. Pass secrets through `common.CryptoParams`, not globals.
- Soft-fail optional key loaders (`Warn`); hard-fail only when decrypt cannot proceed. Normalize QMC map keys with `utils.NormalizeUnicode`.
- OS-specific code: `*_windows.go` / `*_darwin.go` or explicit `//go:build` stubs (see QMC MMKV loaders, `pc_kugou_db`).
- After flag or Go-version changes, update `README.md`. Keep changes minimal; run `go test ./...` for touched packages.