Carthage Software Mago

Mago is a comprehensive toolchain for PHP that helps developers write better code. Inspired by the Rust ecosystem, Mago brings speed, reliability, and an exceptional developer experience to PHP projects of all sizes.

#Table of Contents

• Installation
• Getting Started
• Features
• Our Sponsors
• Contributing
• Inspiration & Acknowledgements
• License

#Installation

The most common way to install Mago on macOS and Linux is by using our shell script:

curl --proto '=https' --tlsv1.2 -sSf https://carthage.software/mago.sh | bash

To install a specific version:

curl --proto '=https' --tlsv1.2 -sSf https://carthage.software/mago.sh | bash -s -- --version=1.0.0

For all other installation methods, including Homebrew, Composer, and Cargo, please refer to our official Installation Guide.

#Getting Started

To get started with Mago and learn how to configure your project, please visit our Getting Started Guide in the official documentation.

#Features

• ⚡️ Extremely Fast: Built in Rust for maximum performance.
• 🔍 Lint: Identify issues in your codebase with customizable rules.
• 🔬 Static Analysis: Perform deep analysis of your codebase to catch potential type errors and bugs.
• 🛠️ Automated Fixes: Apply fixes for many lint issues automatically.
• 📜 Formatting: Automatically format your code to adhere to best practices and style guides.
• 🧠 Semantic Checks: Ensure code correctness with robust semantic analysis.
• 🌳 AST Visualization: Explore your code’s structure with Abstract Syntax Tree (AST) parsing.

#Our Sponsors

See all sponsors

#Contributing

Mago is a community-driven project, and we welcome contributions! Whether you're reporting bugs, suggesting features, writing documentation, or submitting code, your help is valued.

• See our Contributing Guide to get started.
• Join the discussion on Discord.

#Inspiration & Acknowledgements

Mago stands on the shoulders of giants. Our design and functionality are heavily inspired by pioneering tools in both the Rust and PHP ecosystems.

#Inspirations:

• Clippy: For its comprehensive linting approach.
• OXC: A major inspiration for building a high-performance toolchain in Rust.
• Hakana: For its deep static analysis capabilities.

#Acknowledgements:

We deeply respect the foundational work of tools like PHP-CS-Fixer, Psalm, PHPStan, and PHP_CodeSniffer. While Mago aims to offer a unified and faster alternative, these tools paved the way for modern PHP development.

#License

Mago is dual-licensed under your choice of the following:

• MIT License (LICENSE-MIT)
• Apache License, Version 2.0 (LICENSE-APACHE)