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 — это open-source реализация uTools — быстрого расширяемого лаунчера приложений и платформы плагинов для macOS и Windows.
Это готовое приложение или то, на чём мне нужно что-то собирать самому?И то и другое: это десктопный лаунчер, который устанавливается и работает сразу из коробки, и одновременно платформа плагинов — плагины могут быть с интерфейсом или без него, плюс есть встроенный маркет плагинов.
Как его установить и открыть на экране?Скачайте готовый установщик из Releases (.dmg или .zip для macOS, setup.exe или .zip для Windows) либо соберите из исходников. Когда приложение запущено, главный интерфейс открывается по Option+Z (macOS) или Alt+Z (Windows).
Есть ли версия для Linux?Пока нет — выпускается только для macOS и Windows. Поддержка Linux есть в планах, вместе с автообновлением плагинов и необязательной облачной синхронизацией.
Что он умеет помимо запуска приложений?Он также работает как менеджер буфера обмена: ведёт историю, умеет искать и работает с картинками. Поиск понимает Pinyin и регулярные выражения, приложения можно закреплять, а ещё есть шесть цветовых тем со светлым, тёмным и системным режимами.
Где взять больше плагинов?Есть встроенный маркет плагинов, где их можно устанавливать и управлять ими онлайн, при этом каждый плагин хранит свои данные в изолированном хранилище.
Насколько сложно написать свой плагин?Несложно: плагин описывается стандартным файлом plugin.json, а глобальный объект ztools даёт API для уведомлений, эмуляции ввода и постоянного хранилища. Плагины могут срабатывать по тексту, регулярному выражению или глобальным хукам, а при разработке поддерживается hot reload.
На чём он сделан?Electron 41, Vue 3 и TypeScript, база данных LMDB, архитектура на WebContentsView и поисковый движок Fuse.js. Нативные модули C++ на Node-API отвечают за отслеживание буфера обмена, управление окнами и скриншоты области экрана в Windows.
What are similar projects?rubick, rustcast, PicGo, tinycast, Wox, DSH-Launcher, pi-gui, gyotaku
Size
26 MB
Stars
4K
Age
10mo
Commits · 90 Days