@finogeeks2026/finclip-desktop
v1.7.5
Published
FinClip Desktop SDK for npm
Readme
这里是一份为你准备的中文 README.md 文档。它清晰地解释了如何安装、使用以及各个参数的含义。
FinClip Desktop SDK Download Tool
finclip-desktop 是 FinClip 桌面端 SDK 的 npm 封装。本包包含了一个用于下载 FinClip SDK 二进制文件(动态链接库/静态库)的命令行工具。
该工具会根据 package.json 中的版本号,自动从指定的 CDN 下载对应版本的 SDK。
安装
npm install finclip-desktop --save-dev命令行工具使用指南 (CLI)
安装后,你可以通过 npx 直接运行下载命令,或者将其配置在 package.json 的 scripts 中。
必选参数说明
在使用该工具时,必须 提供以下两个参数:
| 参数 | 说明 | 是否必填 | 示例 |
| :------- | :------------------------------- | :------- | :-------------------- |
| --url | SDK 下载的 CDN 根路径 (Base URL) | 是 | https://example.com |
| --dest | SDK 存放的目标文件夹路径 | 是 | ./bin/sdk |
| --all | 下载所有支持平台/架构的 SDK | 否 | (无值开关) |
场景一:下载当前系统的 SDK (开发模式)
如果你只是在本地开发,需要下载适配当前操作系统(Windows/Mac/Linux)和 CPU 架构(x64/arm64)的 SDK:
npx download-finclip --url https://example.com --dest ./sdk效果:
- 工具会自动识别你的 OS 和架构。
- 下载对应的压缩包并保存到
./sdk目录下。
场景二:下载所有平台的 SDK (CI/打包模式)
如果你需要在一个脚本中下载所有支持平台(Linux, Windows, macOS)的 SDK(例如在 CI/CD 流水线中进行多平台构建):
npx download-finclip --url https://example.com --dest ./sdk --all效果:
- 为了防止文件名冲突(不同架构可能拥有相同的文件名),启用
--all参数后,工具会自动在该目录下创建子文件夹。
目录结构示例:
./dest/
├── linux/
│ ├── x64/
│ └── arm64/
├── win/
│ ├── x86/
│ └── x64/
└── darwin/
├── x64/
└── arm64/在项目中使用
建议将下载命令配置到 package.json 的 scripts 中,以便团队成员快速初始化环境。
package.json 示例:
{
"name": "my-electron-app",
"version": "1.0.0",
"scripts": {
"download-finclip": "download-finclip --url https://example.com --dest ./libs",
"download-all-finclip": "download-finclip --url https://example.com --dest ./libs --all",
"postinstall": "npm run download-sdk"
},
"devDependencies": {
"finclip-desktop": "^1.7.3"
}
}- 运行
npm run download-sdk即可下载当前环境所需的 SDK。 - 如果配置了
postinstall,在执行npm install后会自动触发下载。
版本说明
下载器会读取当前 finclip-desktop 包内 package.json 的 version 字段(例如 1.7.3),并将其拼接到 URL 中进行下载。如果你需要下载不同版本的 SDK,请更新本 npm 包的版本。
错误排查
如果运行报错:
Error: Missing required argument: --url
请检查命令中是否遗漏了 --url 参数。为了灵活性,下载地址必须显式指定,工具没有内置默认下载地址。
