Skip to content

pd4d10/debugtron

Repository files navigation

Debugtron

lint

Debugtron is a powerful desktop debugging tool for in-production Electron applications. Built with Electron, React, and TypeScript, it provides a comprehensive interface to discover, launch, and debug any Electron app with professional DevTools integration.

Screenshot

✨ Features

  • πŸ” Automatic App Discovery: Cross-platform detection of installed Electron applications with visual interface
  • πŸš€ One-Click Debug Sessions: Launch any Electron app with debugging flags enabled, support multiple simultaneous sessions
  • πŸ› οΈ DevTools Integration: Access Chrome DevTools for both Node.js main process and renderer processes
  • πŸ“Š Real-Time Monitoring: Live stdout/stderr logging with professional terminal interface

🎯 Use Cases

  • Development & Testing: Debug production builds, profile performance, and validate features
  • Production Support: Investigate deployed app issues and reproduce customer problems
  • Quality Assurance: Test apps without built-in debugging across different platforms

πŸ“¦ Installation

Download the latest release for your platform:

πŸ“₯ Download from GitHub Releases

Supported Platforms

  • Windows (x64)
  • macOS (Intel & Apple Silicon)
  • Linux (x64, AppImage)

πŸš€ Quick Start

  1. Launch Debugtron - Open the application
  2. Select an App - Choose from automatically discovered Electron applications
  3. Start Debugging - Click to launch the app with debugging enabled
  4. Open DevTools - Click "Inspect" buttons to open DevTools for different processes
  5. Monitor Logs - View real-time application output in the integrated terminal

πŸ”§ Development

Prerequisites

  • Node.js 18+
  • Yarn package manager

Setup

# Clone the repository
git clone https://github.com/pd4d10/debugtron.git
cd debugtron

# Install dependencies
yarn install

# Start development
yarn dev

# Build for production
yarn build

# Package for distribution
yarn package

Project Structure

src/
β”œβ”€β”€ main/           # Electron main process
β”‚   β”œβ”€β”€ actions.ts  # Redux thunk actions
β”‚   β”œβ”€β”€ platforms/  # Platform-specific app discovery
β”‚   └── main.ts     # Main entry point
β”œβ”€β”€ renderer/       # React frontend
β”‚   β”œβ”€β”€ app.tsx     # Main app component
β”‚   β”œβ”€β”€ session.tsx # Debug session interface
β”‚   └── header.tsx  # App selection header
β”œβ”€β”€ reducers/       # Redux state management
└── preload.ts      # Secure IPC preload script

🀝 Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

Development Guidelines

  • Use TypeScript with strict mode
  • Follow the existing code style and patterns
  • Write clear commit messages
  • Test on multiple platforms when possible

πŸ“„ License

MIT License - see LICENSE for details.

About

Debug in-production Electron based app

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors