Skip to content

Latest commit

 

History

History
202 lines (138 loc) · 5.35 KB

README_EN.md

File metadata and controls

202 lines (138 loc) · 5.35 KB
Raw

Install

Ensure the version of your installed Node.js is greater than 16.0 such as 16.8. Do not use sudo to install. If you encountered permission issues/problems while installing using npm, see How to fix npm throwing error without sudo.

npm install -g pake-cli

Notes for Windows & Linux users

  • VERY IMPORTANT: Check out the Tauri prerequisites before proceeding.

  • For Windows users who had been installed Win10 SDK (10.0.19041.0) and Visual Studio build tool 2022(>=17.2), you may need to install these additionally:

    1. Microsoft Visual C++ 2015-2022 Redistributable (x64)
    2. Microsoft Visual C++ 2015-2022 Redistributable (x86)
    3. Microsoft Visual C++ 2012 Redistributable (x86) (optional)
    4. Microsoft Visual C++ 2013 Redistributable (x86) (optional)
    5. Microsoft Visual C++ 2008 Redistributable (x86) (optional)

  • For Ubuntu users, run the following commands to install the required libraries before compiling:

    sudo apt install libdbus-1-dev \
    libsoup2.4-dev \
    libjavascriptcoregtk-4.0-dev \
    libwebkit2gtk-4.0-dev \
    build-essential \
    curl \
    wget \
    libssl-dev \
    libgtk-3-dev \
    libayatana-appindicator3-dev \
    librsvg2-dev \
    gnome-video-effects \
    gnome-video-effects-extra

Usage

pake url [options]

The packaged application will be placed in the current working directory by default. Since the environment needs to be configured for the first packaging, it will take some time. Please wait patiently.

Note: The Rust environment is required for packaging. If you have not installed Rust, you will be prompted to confirm the installation. If the installation fails or times out, you can install by yourself.

url

The url🔗 is the link to the website you want to package. Required.

[options]

We provide some options for customization. When packaging, the corresponding arguments can be passed to configure your app.

[name]

The name of your application. We will prompt you to enter this if you do not provide it in this phase. Input must be in English.

--name <value>
# or
-n <value>

[icon]

The application icon. Supports local and remote files. By default, it is the brand icon of Pake. For customizing the icon of your product, go to icon icons or macOSicons to download it.

  • macOS must be .icns
  • Windows must be .ico
  • Linux must be .png
--icon <path>
# or
-i <path>

[height]

The height of the packaged application window. The default is 780px.

--height <number>
# or
-h <number>

[width]

The width of the packaged application window. The default is 1200px.

--width <number>
# or
-w <number>

[transparent]

Whether to enable the immersive header. The default is false. Use the command below to enable this feature.

--transparent

[fullscreen]

Indicates if the window should be full screen on application launch. The default is false. Use the command below to enable this feature.

--fullscreen

[resize]

Indicates if the window can be resized. The default value is true. Use the command below to disable this feature.

--no-resizable
#or
-r

[multi-arch]

Package results support both Intel and m1 chips, only for MacOS. The default is false.

--targets xxx
Preparation
  • Note: After enabling this option, you need to use rustup on the rust official website to install rust, brew installation is not supported.
  • For intel chip users, you need to install the arm64 cross-platform package to make the installation package support the m1 chip, and use the following command to install.
rustup target add aarch64-apple-darwin
  • For M1 chip users, you need to install the x86 cross-platform package to make the installation package support the interl chip, and use the following command to install.
rustup target add x86_64-apple-darwin
Instructions
--multi-arch
# or
-m

[targets]

Select the output package format, support deb/appimage/all, if all is selected, deb and appimage will be packaged at the same time, this option only supports Linux, the default is all.

[user-agent]

Custom browser user agent, default is empty.

--user-agent <value>

[show-menu]

Display the menu bar, not display it by default, enter the following command and it will be displayed. MacOS users are recommended to enable.

--show-menu

[show-system-tray]

Display the notification tray, not display it by default, entering the following command will display.

--show-system-tray <value>

[system-tray-icon]

The notification tray icon is only valid when the notification tray is displayed. The icon must be a 32x32~256x256 pixel image in .ico or .png format.

--system-tray-icon <value>

[copy-iter-file]

Recursive copy, when the url is a local file path, if this option is enabled, the folder where the url path file is located and all sub-files are copied to the pake static folder, which is not enabled by default

--copy-iter-file