pencil README

README проекта с github.com/evolus/pencil. Одним файлом markdown: README.md.

Pencil Logo

Pencil

An open-source GUI prototyping and wireframing application for macOS, Windows, and Linux.

Website • Downloads • Stencils & Templates

GitHub Stars Version License Platforms MCP Protocol

Pencil V4 Interface and Canvas


Overview

Pencil is a free, open-source, desktop-native wireframing and prototyping tool for macOS, Windows, and Linux (pencil.evolus.vn). Built for developers, UX designers, and product teams, it provides an intuitive vector canvas environment for constructing mockups, system diagrams, and user flows using standard vector stencil libraries.

Key Capabilities & Architecture in V4.0

Pencil V4.0 introduces native support for the Model Context Protocol (MCP). This enables any AI assistant or LLM client that supports standard MCP (including Claude Desktop, Cursor, Antigravity, VS Code, or custom agents) to inspect, create, and modify wireframes directly on your canvas using everyday language. Pencil runs a local server right inside the app at http://127.0.0.1:1919/mcp, with no extra background services or cloud setups required.


Quick Start (Prebuilt Binaries)

For end users who do not require building from source:

  1. Download: Obtain the latest installer or package for your operating system from the Pencil Downloads Page or GitHub Releases.
  2. Launch: Open Pencil. You can immediately begin creating wireframes and diagrams using the built-in stencil collections.
  3. Connect AI (Optional): To enable AI-assisted prototyping, follow the setup in Connecting AI Clients below.

Connecting AI Clients

Pencil provides built-in configuration snippets for popular tools (Claude Desktop, Cursor, Antigravity, and VS Code), and works with any client or script that connects to standard MCP HTTP endpoints. Open Settings > MCP, select your assistant tab, and click Copy Configuration to paste directly into your client.

The internal server operates on http://127.0.0.1:1919/mcp (Streamable HTTP / JSON-RPC 2.0). Server status, port assignment, and restarts can be managed directly in the MCP settings pane. To verify endpoint responsiveness externally:

curl -I http://127.0.0.1:1919/mcp
Manual Client Configuration Reference

Claude Desktop

Add to claude_desktop_config.json (~/Library/Application Support/Claude/ on macOS, %APPDATA%\Claude\ on Windows, ~/.config/Claude/ on Linux):

{
  "mcpServers": {
    "pencil": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "http://127.0.0.1:1919/mcp"
      ]
    }
  }
}

Cursor

Add to .cursor/mcp.json or configure under Settings > Features > MCP:

{
  "mcpServers": {
    "pencil": {
      "url": "http://127.0.0.1:1919/mcp"
    }
  }
}

Antigravity

Add to mcp_config.json:

{
  "mcpServers": {
    "pencil": {
      "serverUrl": "http://127.0.0.1:1919/mcp"
    }
  }
}

VS Code

Add to .vscode/mcp.json (or user settings under mcp.servers):

{
  "servers": {
    "pencil": {
      "type": "http",
      "url": "http://127.0.0.1:1919/mcp"
    }
  }
}

Example Interaction Prompts

AI assistants connected to Pencil can execute complex multi-step canvas workflows. Below are representative prompts:

[!TIP] Prompting Best Practice: For the cleanest layouts, explicitly reference your desired stencil library (e.g., "Use shadcn/ui stencils..." or "Pick an icon from the Lucide collection..."). This instructs the assistant to reuse standardized design system components instead of generic raw rectangles.

Scaffolding New Screens

Component Refinement & Styling

Icon & Asset Placement

Structural Layout Shifts & Visual QA


MCP Tools Reference

Pencil exposes its internal API through 5 catalog modules:

Category Tools Description
Canvas Mutation insert_shapes, update_shapes, delete_shapes, move_shapes, align_shapes, distribute_shapes, shift_layout, select_shapes Create, modify, position, and reorder vector shapes, containers, and properties.
Document Management get_active_document, get_page_content, list_pages, create_page, update_page, rename_page, delete_page, switch_page, export_page Manage document structure, multi-page hierarchies, navigation, and exports.
Inspection & Vision render_preview, find_shapes, find_shapes_in_canvas, list_shapes Generate visual snapshots for LLM vision inspection and query shape hierarchies.
Stencils & Resources list_collections, list_shape_definitions, get_shape_definition, list_resource_collections, list_resource_dir, search_resources Discover installed stencil libraries, component templates, and vector icon collections.
Guidance & Skills list_skills, use_skill, read_knowledge_base_document Access embedded design rules, stencil construction guidelines, and best practices.

Stencil & Icon Ecosystem

Pencil includes built-in collections and supports custom stencil installation:

Stencil Repositories & Resources

Additional collections and export templates can be installed through multiple sources:


Development & Building from Source

Prerequisites

Installation

  1. Clone the repository and check out the target branch:

    git clone https://github.com/evolus/pencil.git
    cd pencil
    git checkout development
    
  2. Install project dependencies:

    yarn install
    # or
    npm install
    
  3. Launch the development build:

    yarn start
    # or
    npm start
    

    For dev tools and inspection windows enabled:

    npm run start:dev
    

Packaging & Distribution

To compile production bundles for your host platform:

# macOS (DMG, universal / arm64 / x64)
npm run dist:osx

# Windows (NSIS Installer)
npm run dist:win32

# Linux (deb, rpm, tar.gz)
npm run dist:linux

Output binaries are written to the dist/ directory.


Supported Platforms

macOS

Windows

Linux


Contributing

Contributions are welcome. Please refer to the following workflow:

  1. Fork the repository and create a descriptive feature branch (feature/your-feature-name).
  2. Adhere to existing code conventions and formatting guidelines defined in .editorconfig.
  3. Test your changes locally across standard canvas operations and MCP endpoints.
  4. Submit a pull request against the integration branch with a concise summary of changes.

For security concerns or defect reports, please open an issue using the provided issue templates.


Star History

Pencil Star History Chart

License

Pencil is open-source software licensed under the GNU General Public License v2.0 (GPL-2.0).

Copyright © 2008–2026 Evolus and individual contributors.

pencil (evolus/pencil)

Ищем в базе…

9.9K ·GitHub
Что это такое?Pencil — бесплатное приложение с открытым исходным кодом для настольных компьютеров, предназначенное для прототипирования интерфейсов, создания каркасов (wireframes) и диаграмм на macOS, Windows и Linux.
Это самостоятельное настольное приложение или плагин для другой программы?Это самостоятельное настольное приложение на основе Electron с собственным векторным холстом, а не расширение для браузера и не плагин.
Как его запустить?Скачайте установщик для вашей ОС со страницы Pencil Downloads или из GitHub Releases и запустите его; также можно клонировать репозиторий и запустить приложение из исходного кода с помощью npm или yarn.
Нужно ли подключение к интернету или облачный аккаунт, чтобы пользоваться функциями ИИ?Нет: сервер MCP работает локально внутри приложения через loopback (127.0.0.1), а все данные документов остаются на вашем компьютере без облачной синхронизации и телеметрии.
Для кого это предназначено?Для разработчиков, UX-дизайнеров и продуктовых команд, которым нужно создавать макеты, диаграммы и пользовательские сценарии.
Pencil отправляет куда-либо мои каркасы или данные дизайна?Нет, всё остаётся локально через loopback, и никакая аналитика или телеметрия сторонних сервисов не отправляется.
Какие ИИ-ассистенты могут подключиться к Pencil?Любой клиент, поддерживающий Model Context Protocol (MCP), включая Claude Desktop, Cursor, Antigravity и VS Code; готовые фрагменты конфигурации доступны в Settings > MCP.
Что ИИ-ассистент может делать после подключения?Он может вставлять, перемещать, изменять размер и стилизовать векторные фигуры, управлять страницами, искать в библиотеках иконок и трафаретов, а также делать визуальный снимок холста, чтобы проверить выравнивание и контраст перед дальнейшими правками.
Какие библиотеки трафаретов и наборы иконок есть в комплекте?Библиотеки UI-фреймворков: shadcn/ui, Bootstrap, Material Design, iOS и Android, а также фигуры для блок-схем, UML и ER-диаграмм и каталоги иконок Tabler, Lucide и FontAwesome. Другие можно добавить из community-репозитория Stencils Repository.
Элементы, созданные ИИ, — это просто плоские изображения или их можно редактировать потом?Это настоящие векторные примитивы (а не растровые изображения), поэтому любую созданную ИИ фигуру можно изменить по размеру, перестилизовать или переместить так же, как нарисованную вручную.
Какие есть похожие проекты?huashu-design, k-style-ui-ux, oil-ui, penpot, Awesome-Design-Tools, openpencil, effective-html, drawio-desktop
Автор
evolus
Размер
38.1 MB
Звёзды
9.9K
Возраст
12 г
Коммиты · 90 дней