Welcome to the Puppet Framework documentation. This guide will help you understand the core concepts, architecture design, and how to use the Puppet Framework to build desktop applications.

Table of Contents

• Getting Started - Get started with the Puppet Framework in 5 minutes
• Introduction - Learn about the features and characteristics of the Puppet Framework
• Architecture - Deep dive into the framework's internal architecture and working principles
• Project Structure - Standard directory structure for Puppet projects
• PUP File Format - Understand Puppet's unique packaging format
• PUP Startup Script - Use startup scripts to configure application windows
• Command Line Parameters - Command line tool usage instructions
• Security Mechanisms - Framework security features and best practices
• Best Practices - Recommendations for developing high-quality Puppet applications
• Puppet Signing Tool - Use puppet-sign for signing and verification
• TypeScript Type Definitions - TypeScript type definitions and testing support

Related Tools

• puppet-sign - Standalone signing tool for generating signing key pairs, signing databases, and verifying signatures
  • Supports generating self-signed X.509 certificates
  • Supports RSA 2048/4096-bit keys
  • Supports database signing and verification
  • See Puppet Signing Tool for details

What is Puppet?

Puppet is a Windows desktop application development framework based on WebView2 that allows developers to build powerful desktop applications using familiar web technologies (HTML, CSS, JavaScript).

Core Features

• Web Technology Stack: Build interfaces using HTML, CSS, JavaScript
• Native System Integration: Complete access to Windows system functionality
• Event-Driven: Supports USB device, disk, window, and other event monitoring
• Security Mechanisms: Built-in permission control and security verification
• Unique Packaging: Supports encrypted PUP packaging format

Use Cases

• Desktop applications requiring system-level functionality
• Device management tools
• System monitoring tools
• Tray applications
• Transparent window applications
• Rapid prototype development

Technology Stack

The Puppet Framework is built on the following technologies:

• .NET 10.0 - Core framework
• Windows Forms - Desktop UI framework
• WebView2 - Edge-based web rendering engine
• COM Interop - Bridge between JavaScript and C#
• WMI - Windows Management Interface for device monitoring

Quick Links

• API Documentation - Complete API reference manual
• GitHub Repository - Source code
• Issue Tracker - Submit issues and suggestions

Getting Help

If you encounter issues during usage:

1. Check the relevant sections of this documentation
2. View API Documentation for specific usage
3. Search Known Issues
4. Submit issues on GitHub Issues

Next Steps

It is recommended to read the documentation in the following order:

1. Read Getting Started to create your first Puppet application
2. Learn about Introduction to master core concepts
3. Study Architecture to understand working principles
4. Reference API Documentation for actual development
5. Follow Best Practices to develop high-quality applications

Changelog

4/5/26, 4:22 AM

View All Changelog

• db86e-docs: add TypeScript type definitions documentationon 4/5/26

Edit this page

Contributors: bil-fis

Next pageIntroduction