Download the PHP package gemui/php-debug-pilot without Composer
On this page you can find all versions of the php package gemui/php-debug-pilot. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package php-debug-pilot
PHP Debug Pilot 🚀
Zero-Configuration PHP Debugging Setup.
PHP Debug Pilot is an enterprise-grade CLI tool that automatically detects your environment, installs and configures Xdebug, and generates ready-to-use launch configurations for your favorite IDE. Stop wrestling with php.ini and port mappings — just fly.
✨ Features
- 🔍 Environment Detection — Automatically detects OS (macOS, Linux, Windows), Docker containers, and
php.inilocation - ⚙️ Smart Configuration
- Configures Xdebug for step debugging (mode
debug, auto-client-host) - Idempotent — runs safely multiple times without duplicating config blocks
- Configures Xdebug for step debugging (mode
- 📦 Extension Management
- Check Status — View installed/enabled status of Xdebug at a glance
- Toggle — Enable or disable extensions with a single command
- Auto-Install — Detects missing extensions and offers to install them for you (macOS/Linux)
- 💻 IDE Integration — Generates project-specific config files for:
- VS Code (
.vscode/launch.json) - Sublime Text (
*.sublime-project) - Planned editors (contributions welcome!):
- [ ] PhpStorm
- [ ] Vim / Neovim
- [ ] Zed
- [ ] Athas
- VS Code (
- 🏥 Health Checks — Verifies your installation and reports actionable warnings (e.g., missing extensions, wrong modes)
📦 Installation
Requirements
- PHP
^8.2 - Composer (for Method 2 & 3 only)
Method 1: Standalone PHAR (Zero Dependencies)
This is the best method if you don't want to manage global Composer dependencies or prefer a single executable file.
Download and install the standalone PHAR:
Verify the installation:
Method 2: Via Composer (Global)
Install once and use debug-pilot from anywhere:
⚠️ Important: Ensure your global Composer binaries directory is in your system's
$PATH.Typically this is
~/.composer/vendor/binor~/.config/composer/vendor/bin.Add it to your shell profile if you haven't already:
After installing globally, you can use debug-pilot directly:
Method 3: Per-Project Installation
Add it as a dev dependency to a specific project:
Then use it via Composer's local bin:
🔄 Updating
Method 1: PHAR
The PHAR binary includes a built-in self-update command that downloads the latest release from GitHub:
Method 2: Global Composer
Method 3: Per-Project
🚀 Usage
Interactive Setup
Run the setup wizard to configure extensions and generate IDE files:
The tool will:
- 🔍 Detect your environment
- 🐛 Ask which debugger you want to configure (Xdebug)
- 💻 Ask which IDE you use
- ✅ Write the configuration and verify the setup
Check Status
See which extensions are installed and enabled:
Output:
Enable / Disable Extensions
Toggle extension state without editing php.ini manually:
💡 Tip: If the extension is not installed, the tool will offer to install it for you automatically (on supported systems).
Install Extensions
Manually install a specific extension:
🔧 The tool will automatically detect if auto-installation is supported on your system and run the appropriate installation command. If auto-installation is not available (e.g., Docker, Windows), it will display manual installation instructions.
Non-Interactive Setup
Perfect for CI/CD pipelines or automated setup scripts:
Setup Options
| Option | Description | Default |
|---|---|---|
-p, --project-path |
Root path of your project (where IDE config is written) | Current directory |
-d, --debugger |
Debugger to configure (xdebug) |
(Prompts user) |
-i, --ide |
IDE to configure (vscode, sublime) |
(Prompts user) |
--host |
Xdebug client host IP | auto (detects Docker host or localhost) |
--port |
Xdebug client port | 9003 |
--xdebug-mode |
Xdebug modes, comma-separated (debug, develop, coverage, profile, trace) |
(Prompts user with current modes pre-selected) |
🐳 Using with Docker
Generating Docker Config
Use the init-docker command to generate ready-to-use Docker configuration snippets:
Dockerfile Setup
Add the generated snippet to your Dockerfile (after FROM php:8.x-*):
Docker Compose Override
Use the --write-compose flag to generate a docker-compose.debug.yml:
Then run with both files:
Running Debug Pilot Inside a Container
You can run debug-pilot directly inside a running container. On official PHP Docker images (php:*), it will auto-install extensions for you:
💡 Tip: Debug Pilot automatically detects Docker environments and resolves
host.docker.internalas the debug client host. On Linux Docker, it discovers the gateway IP from/proc/net/route.
Init Docker Options
| Option | Description | Default |
|---|---|---|
-d, --debugger |
Debugger to configure (xdebug) |
xdebug |
--port |
Debug client port | 9003 |
--write-compose |
Write docker-compose.debug.yml to project |
false |
-p, --project-path |
Project root path | Current directory |
🖥️ Supported Platforms
- Operating Systems: macOS, Linux, Windows, Docker Containers
- Debuggers: Xdebug 3+
- IDEs: VS Code, Sublime Text 3/4
🔧 Troubleshooting
"Extension is not installed" warning?
Run debug-pilot install <extension> (or toggle) and follow the interactive prompts to install it. Or install manually:
- macOS:
pecl install xdebug - Ubuntu:
sudo apt install php-xdebug - Docker:
RUN pecl install xdebug && docker-php-ext-enable xdebug
"Cannot write to php.ini"?
Run the tool with sudo if your php.ini is system-protected:
PHAR not working?
Ensure the PHAR has execute permissions:
If you encounter "command not found", verify /usr/local/bin is in your $PATH:
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
Made with ☕ by Gemui
All versions of php-debug-pilot with dependencies
laravel-zero/framework Version ^11.0
laravel-zero/phar-updater Version ^1.4