167 lines
4.0 KiB
Markdown
Vendored
167 lines
4.0 KiB
Markdown
Vendored
## 安装
|
||
|
||
```bash
|
||
npm install -g pake-cli
|
||
```
|
||
|
||
如果安装失败提示没有权限，请参考该贴解决：[链接](https://gist.github.com/Giancarlos/d087f8a9e6516716da98ad0c0f5a8f58)。
|
||
|
||
此外，请确保你使用的是正确的 Node.js 版本（`^14.13 || >=16.0.0`）。如果你在使用 [nvm](https://github.com/nvm-sh/nvm) 进行 Node.js 版本管理，可以尝试在项目的目录下运行 `nvm use`，就会拿到正确的版本；其他一众 Node.js 版本工具，比如 [fnm](https://github.com/Schniz/fnm)、[tj/n](https://github.com/tj/n) 应该也有类似的功能。
|
||
|
||
**尽量不要使用 `sudo` 权限**。 如果实在要用 sudo，请手动安装 rust 到系统环境。Mac 可以用 brew 命令安装，Linux 如 Ubuntu 可以用 apt 命令安装。
|
||
|
||
|
||
## 用法
|
||
|
||
```bash
|
||
pake url [options]
|
||
```
|
||
|
||
打包完成后的应用程序默认为当前工作目录，首次打包由于需配置好环境，需要一些时间，请耐心等待即可。
|
||
|
||
Note: 打包需要用 `Rust` 环境，如果没有 `Rust`，会提示确认安装。如遇安装失败或超时，可[自行安装](https://www.rust-lang.org/tools/install)。
|
||
|
||
### url
|
||
|
||
url 为你需要打包的网页链接 🔗或者本地html文件，必须提供。
|
||
|
||
### [options]
|
||
|
||
提供了一些特定的选项，打包时可以传递对应参数达到定制化的效果。
|
||
|
||
#### [name]
|
||
|
||
应用名称，如输入时未指定，会提示你输入，尽量使用英语。
|
||
|
||
```shell
|
||
--name <value>
|
||
```
|
||
|
||
#### [icon]
|
||
|
||
应用 icon，支持本地/远程文件，默认为 Pake 自带图标，定制的可以去 [icon-icons](https://icon-icons.com) 或 [macOSicons](https://macosicons.com/#/) 搜索下载。
|
||
|
||
- MacOS 下必须为 `.icns`
|
||
- Windows 下必须为 `.ico`
|
||
- Linux 下必须为 `.png`
|
||
|
||
```shell
|
||
--icon <path>
|
||
```
|
||
|
||
#### [height]
|
||
|
||
打包后的应用窗口高度，默认 `780px`。
|
||
|
||
```shell
|
||
--height <number>
|
||
```
|
||
|
||
#### [width]
|
||
|
||
打包后的应用窗口宽度，默认 `1200px`。
|
||
|
||
```shell
|
||
--width <number>
|
||
```
|
||
|
||
#### [transparent]
|
||
|
||
是否开启沉浸式头部，默认为 `false` 不开启，输入下面的命令则开启沉浸式，推荐MacOS用户开启。
|
||
|
||
```shell
|
||
--transparent
|
||
```
|
||
|
||
#### [resize]
|
||
|
||
是否可以拖动大小，默认为 `true` 可拖动，输入下面的命令则不能对窗口大小进行拉伸。
|
||
|
||
```shell
|
||
--no-resizable
|
||
```
|
||
|
||
#### [fullscreen]
|
||
|
||
打开应用后是否开启全屏，默认为 `false`，输入下面的命令则会自动全屏。
|
||
|
||
```shell
|
||
--fullscreen
|
||
```
|
||
|
||
#### [user-agent]
|
||
|
||
自定义浏览器请求头, 默认为空。
|
||
|
||
```shell
|
||
--user-agent <value>
|
||
```
|
||
|
||
#### [show-menu]
|
||
|
||
显示菜单栏, 默认不显示，输入下面的命令则会显示，推荐MacOS用户开启。
|
||
|
||
```shell
|
||
--show-menu
|
||
```
|
||
|
||
#### [show-system-tray]
|
||
|
||
显示通知栏托盘, 默认不显示，输入下面的命令则会显示。
|
||
|
||
```shell
|
||
--show-system-tray
|
||
```
|
||
|
||
#### [system-tray-icon]
|
||
|
||
通知栏托盘图标，仅当显示通知栏托盘时有效, 图标必须为.ico或者.png格式的，512*512像素的图片。
|
||
|
||
```shell
|
||
--system-tray-icon <value>
|
||
```
|
||
|
||
|
||
#### [copy-iter-file]
|
||
|
||
递归拷贝，当url为本地文件路径时候，若开启该选项，则将url路径文件所在文件夹以及所有子文件都拷贝到pake静态文件夹，默认不开启
|
||
|
||
```shell
|
||
--copy-iter-file
|
||
```
|
||
|
||
|
||
#### [multi-arch]
|
||
|
||
打包结果同时支持英特尔和 m1 芯片，仅适用于 MacOS，默认为 `false`。
|
||
|
||
##### 准备工作
|
||
|
||
- 注意：开启该选项后，需要用 rust 官网的 rustup 安装 rust，不支持 brew 安装。
|
||
- 对于 intel 芯片用户，需要安装 arm64 跨平台包，使安装包支持 m1 芯片，使用下面命令安装。
|
||
|
||
```shell
|
||
rustup target add aarch64-apple-darwin
|
||
```
|
||
|
||
- 对于 M1 芯片用户，需要安装 x86 跨平台包，使安装包支持 interl 芯片，使用下面的命令安装。
|
||
|
||
```shell
|
||
rustup target add x86_64-apple-darwin
|
||
```
|
||
|
||
##### 使用方法
|
||
|
||
```shell
|
||
--multi-arch
|
||
# 或者
|
||
-m
|
||
```
|
||
|
||
#### [targets]
|
||
|
||
选择输出的包格式，支持deb/appimage/all，如果选择all,则同时打包deb和appimage，该选项仅支持Linux，默认为`all`。
|
||
|
||
```shell
|
||
--targets xxx
|
||
``` |