Pake/bin at ae2c5e0a17484cbeb15619f0cc425db3f3ac461e - Pake

Ensure that your Node.js version is 22.0 or higher (e.g., 22.11.0). Note: Older versions ≥16.0.0 may also work. Avoid using sudo for the installation. If you encounter permission issues with npm, refer to How to fix npm throwing error without sudo.

npm install pake-cli -g

Considerations for Windows & Linux Users

CRITICAL: Consult Tauri prerequisites before proceeding.
For Windows users (ensure that Win10 SDK (10.0.19041.0) and Visual Studio build tool 2022 (>=17.2) are installed), additional installations are required:
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 Windows on ARM (ARM64) support: Install the C++ ARM64 build tools in Visual Studio Installer under "Individual Components" → "MSVC v143 - VS 2022 C++ ARM64 build tools". The system will automatically detect ARM64 architecture and build native ARM64 binaries.

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

sudo apt install libdbus-1-dev \
    libsoup-3.0-dev \
    libjavascriptcoregtk-4.1-dev \
    libwebkit2gtk-4.1-dev \
    build-essential \
    curl \
    wget \
    libssl-dev \
    libgtk-3-dev \
    libayatana-appindicator3-dev \
    librsvg2-dev \
    gnome-video-effects \
    gnome-video-effects-extra

CLI Usage

pake [url] [options]

The packaged application will be located in the current working directory by default. The first packaging might take some time due to environment configuration. Please be patient.

macOS Output: On macOS, Pake creates DMG installers by default. To create .app bundles for testing (to avoid user interaction), set the environment variable PAKE_CREATE_APP=1.

Note: Packaging requires the Rust environment. If Rust is not installed, you will be prompted for installation confirmation. In case of installation failure or timeout, you can install it manually.

[url]

The URL is the link to the web page you want to package or the path to a local HTML file. This is mandatory.

[options]

Various options are available for customization. You can pass corresponding arguments during packaging to achieve the desired configuration.

[name]

Specify the application name. If not provided, you will be prompted to enter it. It is recommended to use English.

Note: Also supports multiple words with automatic platform-specific handling:

Windows/macOS: Preserves spaces and case (e.g., "Google Translate")
Linux: Converts to lowercase with hyphens (e.g., "google-translate")

--name <string>
--name MyApp

# Multiple words (if needed):
--name "Google Translate"

[icon]

Specify the application icon. Supports both local and remote files. By default, it uses the Pake brand icon. For custom icons, visit icon icons or macOSicons.

For macOS, use .icns format.
For Windows, use .ico format.
For Linux, use .png format.

--icon <path>

[height]

Set the height of the application window. Default is 780px.

--height <number>

[width]

Set the width of the application window. Default is 1200px.

--width <number>

[hide-title-bar]

Enable or disable immersive header. Default is false. Use the following command to enable this feature, macOS only.

--hide-title-bar

[fullscreen]

Determine whether the application launches in full screen. Default is false. Use the following command to enable full screen.

--fullscreen

[activation-shortcut]

Set the activation shortcut for the application. Default is empty, so it does not take effect. You can customize the activation shortcut with the following commands, e.g. CmdOrControl+Shift+P. Usage can refer to available-modifiers.

--activation-shortcut <string>

[always-on-top]

Sets whether the window is always at the top level, defaults to false.

--always-on-top

[app-version]

Set the version number of the packaged application to be consistent with the naming format of version in package.json, defaulting to 1.0.0.

--app-version <string>

[dark-mode]

Force Mac to package applications using dark mode, default is false.

--dark-mode

[disabled-web-shortcuts]

Sets whether to disable web shortcuts in the original Pake container, defaults to false.

--disabled-web-shortcuts

[multi-arch]

Package the application to support both Intel and M1 chips, exclusively for macOS. Default is false.

Prerequisites

Note: After enabling this option, Rust must be installed using rustup from the official Rust website. Installation via brew is not supported.
For Intel chip users, install the arm64 cross-platform package to support M1 chips using the following command:
```
rustup target add aarch64-apple-darwin
```
For M1 chip users, install the x86 cross-platform package to support Intel chips using the following command:
```
rustup target add x86_64-apple-darwin
```

Usage

--multi-arch

[targets]

Specify the build target architecture or format:

Linux: deb, appimage, deb-arm64, appimage-arm64 (default: deb)
Windows: x64, arm64 (auto-detects if not specified)
macOS: intel, apple, universal (auto-detects if not specified)

--targets <target>

# Examples:
--targets arm64          # Windows ARM64
--targets x64            # Windows x64
--targets universal      # macOS Universal (Intel + Apple Silicon)
--targets apple          # macOS Apple Silicon only
--targets intel          # macOS Intel only
--targets deb            # Linux DEB package (x64)
--targets rpm            # Linux RPM package (x64)
--targets appimage       # Linux AppImage (x64)
--targets deb-arm64      # Linux DEB package (ARM64)
--targets rpm-arm64      # Linux RPM package (ARM64)
--targets appimage-arm64 # Linux AppImage (ARM64)

Note for Linux ARM64:

Cross-compilation requires additional setup. Install gcc-aarch64-linux-gnu and configure environment variables for cross-compilation.
ARM64 support enables Pake apps to run on ARM-based Linux devices, including Linux phones (postmarketOS, Ubuntu Touch), Raspberry Pi, and other ARM64 Linux systems.
Use --target appimage-arm64 for portable ARM64 applications that work across different ARM64 Linux distributions.

[user-agent]

Customize the browser user agent. Default is empty.

--user-agent <string>

[show-system-tray]

Display the system tray. Default is not to display. Use the following command to enable the system tray.

--show-system-tray

[system-tray-icon]

Specify the system tray icon. This is only effective when the system tray is enabled. The icon must be in .ico or .png format and should be an image with dimensions ranging from 32x32 to 256x256 pixels.

--system-tray-icon <path>

[hide-on-close]

Hide the window instead of exiting when clicking the close button. Default is true. When enabled, the application will be minimized to the system tray (if available) or hidden when the close button is clicked, rather than actually closing the application.

--hide-on-close

[title]

Set the window title bar text. If not specified, the window title will be empty.

--title <string>

# Examples:
--title "My Application"
--title "Google Translate"

[incognito]

Launch the application in incognito/private browsing mode. Default is false. When enabled, the webview will run in private mode, which means it won't store cookies, local storage, or browsing history. This is useful for privacy-sensitive applications.

--incognito

[wasm]

Enable WebAssembly support with cross-origin isolation headers. Required for Flutter Web applications and other web applications that use WebAssembly modules like sqlite3.wasm, canvaskit.wasm. Default is false.

This option adds necessary HTTP headers (Cross-Origin-Opener-Policy: same-origin and Cross-Origin-Embedder-Policy: require-corp) and browser flags to enable SharedArrayBuffer and WebAssembly features.

--wasm

# Example: Package a Flutter Web app with WASM support
pake https://flutter.dev --name FlutterApp --wasm

[installer-language]

Set the Windows Installer language. Options include zh-CN, ja-JP, More at Tauri Document. Default is en-US.

--installer-language <language>

[use-local-file]

Enable recursive copying. When the URL is a local file path, enabling this option will copy the folder containing the file specified in the URL, as well as all sub-files, to the Pake static folder. This is disabled by default.

--use-local-file

[inject]

Using inject, you can inject local absolute and relative path css and js files into the page you specify the url to customize it. For example, an adblock script that can be applied to any web page, or a css that optimizes the UI of a page, you can write it once to customize it. would only need to write the app once to generalize it to any other page.

Supports both comma-separated and multiple option formats:

# Comma-separated (recommended)
--inject ./tools/style.css,./tools/hotkey.js

# Multiple options
--inject ./tools/style.css --inject ./tools/hotkey.js

# Single file
--inject ./tools/style.css

[proxy-url]

Set proxy server for all network requests. Supports HTTP, HTTPS, and SOCKS5. Available on Windows and Linux. On macOS, requires macOS 14+.

--proxy-url http://127.0.0.1:7890
--proxy-url socks5://127.0.0.1:7891

[debug]

The packaged application has dev-tools for debugging, in addition to outputting more log messages for debugging.

--debug

Wait a moment

After completing the above steps, your application should be successfully packaged. Please note that the packaging process may take some time depending on your system configuration and network conditions. Be patient, and once the packaging is complete, you can find the application installer in the specified directory.

Development

The DEFAULT_DEV_PAKE_OPTIONS configuration in bin/defaults.ts can be modified at development time to match the pake-cli configuration description.

export const DEFAULT_DEV_PAKE_OPTIONS: PakeCliOptions & { url: string } = {
  ...DEFAULT_PAKE_OPTIONS,
  url: "https://weekly.tw93.fun/",
  name: "Weekly",
};

then

npm run cli:dev

The script will read the above configuration and packages the specified app using watch mode, and changes to the pake-cli code and pake are hot updated in real time.

Docker

# On Linux, you can run the Pake CLI via Docker
docker run -it --rm \ # Run interactively, remove container after exit
    -v YOUR_DIR:/output \ # Files from container's /output will be in YOU_DIR
    ghcr.io/tw93/pake \
    <arguments>

# For example:
docker run -it --rm \
    -v ./packages:/output \
    ghcr.io/tw93/pake \
    https://example.com --name myapp --icon ./icon.png

README.md

English | 简体中文

Installation