🩺 Azure Functions Doctor
Welcome to Azure Functions Doctor — a powerful diagnostic CLI tool built with Python to help you validate and troubleshoot your local Azure Functions environment.
⚡ What Is It?
Azure Functions Doctor analyzes your project folder and environment to detect:
- Missing configuration files (e.g.,
host.json,requirements.txt) - Unsupported Python versions
- Missing dependencies (e.g.,
azure-functions) - Broken or misnamed function folders
- Other common issues that break Azure Functions locally or in CI/CD
It provides clear emoji-based output, rule-based extensibility, and optional JSON formatting.
🚀 When Should You Use This?
| Scenario | Usefulness |
|---|---|
| 🧪 Developing locally | Quickly catch broken setup before you run func start |
| 🚢 Before deployment | Prevent silent 500 errors caused by bad config |
| 🔁 In CI pipeline | Automate validation across repos and branches |
| 🛠 Debugging errors | Eliminate basic mistakes before diving into logs |
🧰 Quick Start
pip install azure-functions-doctor
func-doctor diagnose
View Usage Guide →
See Example Project →
📘 Documentation Overview
| Topic | Description |
|---|---|
| Usage Guide | How to run and interpret results |
| Rule System | Understand and customize rules.json |
| Diagnostics Reference | Full list of built-in checks |
| Developer Guide | Contribute and extend the CLI |
| Release Process | Versioning and PyPI publishing |
💬 Need Help?
Feel free to open an issue or check out our GitHub Discussions.
🧪 Example Output
📄 License
This project is licensed under the MIT License.