Pake README

The project's README from github.com/tw93/Pake. As one markdown file: README.md.

English | 简体中文

Pake

Turn any webpage into a desktop app with one command, supports macOS, Windows, and Linux

twitter telegram GitHub downloads GitHub commit GitHub closed issues

Features

Getting Started

WeRead Mac Windows Linux Twitter Mac Windows Linux
Grok Mac Windows Linux DeepSeek Mac Windows Linux
ChatGPT Mac Windows Linux Gemini Mac Windows Linux
YouTube Music Mac Windows Linux YouTube Mac Windows Linux
LiZhi Mac Windows Linux ProgramMusic Mac Windows Linux
Excalidraw Mac Windows Linux XiaoHongShu Mac Windows Linux
Notion Mac Windows Linux Flomo Mac Windows Linux
🏂 You can download more applications from Releases. Click here to expand the shortcuts reference!
Mac Windows/Linux Function
⌘ + [ Ctrl + ← Return to the previous page
⌘ + ] Ctrl + → Go to the next page
⌘ + ↑ Ctrl + ↑ Auto scroll to top of page
⌘ + ↓ Ctrl + ↓ Auto scroll to bottom of page
⌘ + r Ctrl + r Refresh Page
⌘ + w Ctrl + w Hide window, not quit
⌘ + - Ctrl + - Zoom out the page
⌘ + = Ctrl + = Zoom in the Page
⌘ + 0 Ctrl + 0 Reset the page zoom
⌘ + L Ctrl + L Copy Current Page URL
⌘ + ⇧ + ⌥ + V Ctrl + Shift + V Paste and Match Style
⌘ + ⇧ + H Ctrl + Shift + H Go to Home Page
⌘ + ⌥ + I Ctrl + Shift + I Toggle Developer Tools (Debug Only)
⌘ + ⇧ + ⌫ Ctrl + Shift + Del Clear Cache & Restart
⌃ + ⌘ + F F11 Toggle native window fullscreen

In addition, double-click the title bar to switch to full-screen mode. On Windows and Linux, use --hide-window-decorations for a frameless window with a top drag region. For Mac users, you can also use the gesture to go to the previous or next page and drag the title bar to move the window. The new menu also offers options for navigation, zoom, and window controls.

Command-Line Packaging

Pake

# Install Pake CLI
pnpm install -g pake-cli

# Basic usage - automatically fetches website icon
pake https://github.com --name GitHub

# Advanced usage with custom options
pake https://weekly.tw93.fun --name Weekly --icon https://cdn.tw93.fun/pake/weekly.icns --width 1200 --height 800 --hide-title-bar

First-time packaging requires environment setup and may be slower, subsequent builds are fast. For complete parameter documentation, see CLI Usage Guide. Don't want to use CLI? Try GitHub Actions Online Building.

Using Pake from a script or AI agent? Pass --json for machine-readable results, describe apps declaratively with --config app.json (schema), and package local build output directly with pake ./dist --name MyTool. See llms.txt for the full agent contract. Claude Code users can install the official skill with /plugin marketplace add tw93/Pake and /plugin install pake@pake.

Copy this to your AI agent to get started:

Use Pake (npm i -g pake-cli) to package webpages as desktop apps. Read https://unpkg.com/pake-cli@latest/llms.txt first; always run pake with --json and parse stdout as a single JSON object. Package <url-or-local-dist> into an app named <AppName>.

Development

Requires Rust >=1.85 and Node >=22 (recommended LTS; >=20 also works). For detailed installation guide, see Tauri documentation. If unfamiliar with development environment, use the CLI tool instead.

# Install dependencies
pnpm i

# Local development [right-click to open debug mode]
pnpm run dev

# Build application
pnpm run build

For style customization, feature enhancement, container communication and other advanced features, see Advanced Usage Documentation.

Developers

Pake's development can not be without these Hackers. They contributed a lot of capabilities for Pake. Also, welcome to follow them! ❤️

Contributors

Support

These lovely people already did 🐱

License

Pake is open source under GPL-3.0, see LICENSE and Pake Output Exception; apps you build with Pake are entirely yours to use and distribute. If you fork Pake into your own product, to avoid confusion please give it a different name and credit Pake as the source.

Pake (tw93/Pake)

Searching Database…

62.2K ·GitHub
这是干什么的?Pake 只需要一条命令,就能把任意网页变成一个体积小、速度快桌面应用——ChatGPT、YouTube、Notion,你日常用什么都行。
它是我要基于它开发的框架,还是帮我打包网站的工具?是一个打包工具:你给它一个网址,它就用 Rust Tauri(而不是 Electron)把这个页面打包成一个独立的桌面应用,所以安装包通常不到 10M。
具体怎么把一个网站变成应用?有三条路:直接下载现成的 Popular Package;不用配置任何环境,通过 GitHub Actions 在线构建;或者安装命令行工具(npm i -g pake-cli),一条命令就能打包任意网址。
我的电脑上需要装什么才能打包?在线构建什么都不用装。用命令行打包需要一个 Node 环境(该包要求 Node >=20.9)。从克隆的仓库做自定义开发则需要 Rust >=1.85 和 Node >=22。
第一次打包会比以后慢吗?会——第一次打包需要进行一次性的环境准备,可能比较慢;之后的构建就很快了。
它打包出来的应用在三大桌面系统上都能用吗?可以——支持 macOS、Windows 和 Linux。快捷键因平台而异,在 Windows/Linux 上,--hide-window-decorations 可以得到无边框窗口,并在顶部保留可拖拽区域。
我用 Pake 做出来的应用也会受 GPL-3.0 约束吗?不会——Pake 本身是 GPL-3.0,但多亏了 Pake Output Exception,你用它构建的应用完全可以由你自己使用和分发。不过 Pake 本身的分支(fork)应该换一个名字,并注明来自 Pake。
打包出来的应用除了加载网页,还能干什么?它们支持键盘快捷键、沉浸式窗口、拖拽、样式自定义和去除广告;进阶的样式和功能调整可以看 Advanced Usage 文档。
有没有现成的应用可以直接下载,不用自己打包?有——热门包包括 WeRead、Twitter、Grok、DeepSeek、ChatGPT、Gemini、YouTube Music、Excalidraw、Notion 和 Flomo,列表之外还有更多可以下载。
我能通过脚本或 AI 智能体来用 Pake 吗?可以——--json 输出机器可读的结果,--config app.json 用声明式方式描述应用,pake ./dist 可以打包本地构建产物,Claude Code 用户还能安装官方插件(pake@pake)。
按 Cmd+W / Ctrl+W 会彻底关掉应用吗?不会——它只是隐藏窗口,应用仍在后台运行。Cmd+L 可以复制当前页面网址,有专门的快捷键可以清空缓存并重启,双击标题栏可以切换全屏。
Creator
tw93
Size
70.5 MB
Stars
62.2K
Age
4y
Commits · 90 Days