ZTools README

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

ZTools

ZTools Logo

A High-Performance, Extensible Application Launcher and Plugin Platform

Open Source Implementation of uTools | Supports macOS and Windows

GitHub release License Platform

English | 简体中文

❤️ Sponsors

Want to appear here?

Click to collapse
APIMart Thanks to APIMart for sponsoring this project! APIMart is a low-cost API platform for AI image & video generation — GPT-Image-2 from $0.006/image, 160+ images per dollar. One async API covers both image and video: submit a task, get an ID, fetch results via polling or callback. Batch tens of thousands of images without timeouts, switch models without changing code. Pay-as-you-go with no monthly fee — sign up here to get started.

✨ Features

📸 Preview

ZTools Demo

Quick launch and search functionality demo

Interface Showcase

Main Interface - Light Theme

Main Interface - Light Theme

Main Interface - Dark Theme

Main Interface - Dark Theme

Settings

Settings - Theme Customization and General Settings

Plugin Market

Plugin Market - Online Installation and Management

🚀 Quick Start

Installation

Download the latest version from Releases:

Method 2: Build from Source

# Clone the repository
git clone https://github.com/ZToolsCenter/ZTools.git
cd ZTools

# Install dependencies
pnpm install

# Development mode
pnpm dev

# Build
pnpm build:mac    # macOS
pnpm build:win    # Windows
pnpm build:linux  # Linux (Default Arch)
pnpm build:linux:x64 # Linux (amd64/x64)
pnpm build:linux:arm64 # Linux (arm64)

Usage

  1. After launching the app, use the shortcut Option+Z (macOS) or Alt+Z (Windows) to open the main interface
  2. Enter application name or command to search
  3. Use ↑ ↓ ← → to navigate, Enter to confirm, Esc to exit

🧩 Plugin Development

ZTools is a powerful and extensible plugin platform that enhances your productivity with custom plugins. With simple configuration, rich APIs, and cross-platform support, you can easily develop powerful plugins.

Plugin System Features:

📖 Full Documentation: Visit ZTools Developer Documentation for more details

🛠️ Tech Stack

📁 Project Structure

ztools/
├── src/
│   ├── main/              # Main process
│   │   ├── api/          # IPC API modules
│   │   ├── core/         # Core functionality (database, native modules)
│   │   ├── windowManager.ts
│   │   └── pluginManager.ts
│   ├── preload/          # Preload scripts
│   └── renderer/         # Renderer process (Vue)
│       ├── components/
│       ├── stores/       # Pinia state management
│       └── App.vue
├── resources/            # Resource files
│   ├── lib/             # Native modules (.node)
│   └── preload.js       # Plugin preload
└── CLAUDE.md            # Complete technical documentation

📚 Documentation

💻 Development

Requirements

Development Commands

# Install dependencies
pnpm install

# Development mode (hot reload)
pnpm dev

# Type checking
pnpm typecheck          # All
pnpm typecheck:node     # Main process + preload
pnpm typecheck:web      # Renderer process

# Code formatting
pnpm format             # Prettier formatting
pnpm lint               # ESLint check

# Build
pnpm build              # Compile source code only
pnpm build:mac          # Package macOS app
pnpm build:win          # Package Windows app
pnpm build:linux        # Package Linux app (Default Arch)
pnpm build:linux:x64    # Package Linux app (amd64/x64)
pnpm build:linux:arm64  # Package Linux app (arm64)
pnpm build:unpack       # Package without installer (for debugging)

Debugging

🗺️ Roadmap

Completed ✅

🐛 Issue Reporting

Having issues? Please report them in Issues.

When submitting an issue, please include:

📄 License

This project is licensed under the MIT License.

💝 Acknowledgments


If this project helps you, please give it a Star ⭐️

Made with ❤️ by lzx8589561

ZTools (ZToolsCenter/ZTools)

Searching Database…

这是什么?ZTools 是 uTools 的开源实现。uTools 是一个高性能、可扩展的应用启动器和插件平台,支持 macOS 和 Windows。
它是现成的应用,还是需要我在它基础上开发?两者都是:它是一个装好就能直接用的桌面启动器,同时也是一个插件平台——插件可以带界面,也可以无界面,而且内置了插件市场。
怎么安装并把它调出来?可以从 Releases 下载预构建的安装包(macOS 用 .dmg 或 .zip,Windows 用 setup.exe 或 .zip),也可以从源码自己构建。运行后,按 Option+Z(macOS)或 Alt+Z(Windows)即可打开主界面。
有 Linux 版本吗?目前还没有——只提供 macOS 和 Windows 版本。Linux 支持已在计划中,同时规划的还有插件自动更新和可选的云端同步。
除了启动应用,它还能做什么?它还是一个剪贴板管理器,支持历史记录、搜索和图片。搜索支持拼音和正则匹配,应用可以置顶,还有六种主题颜色,以及浅色、深色和跟随系统三种模式。
怎么获取更多插件?内置了插件市场,可以在线安装和管理插件,而且每个插件的数据都存放在独立的存储空间里。
自己写一个插件麻烦吗?不麻烦:一个插件由标准的 plugin.json 文件定义,全局的 ztools 对象提供了通知、模拟输入和持久化存储等 API。插件可以通过文本、正则或全局热键触发,开发时还支持热重载。
它是用什么技术做的?基于 Electron 41、Vue 3 和 TypeScript,使用 LMDB 数据库、WebContentsView 架构和 Fuse.js 搜索引擎。在 Windows 上,原生 C++ Node-API 模块负责剪贴板监听、窗口管理和区域截图。
What are similar projects?rubick, rustcast, PicGo, tinycast, Wox, DSH-Launcher, pi-gui, gyotaku
Size
26 MB
Stars
4K
Age
10mo
Commits · 90 Days