![\"mule-lint\"](\"docs/assets/logo.svg\"){kind=logo}
\n\n \n
\n ![\"npm](\"https://img.shields.io/npm/v/@sfdxy/mule-lint?style=flat-square&color=34d399\")
![\"CI\"](\"https://img.shields.io/github/actions/workflow/status/Avinava/mule-lint/ci.yml?style=flat-square&color=38bdf8\")
![\"License\"](\"https://img.shields.io/npm/l/@sfdxy/mule-lint?style=flat-square&color=818cf8\")
Find Mule 4 problems before deployment—locally, in CI, or with an AI coding agent.
\n\nmule-lint scans Mule XML, DataWeave, YAML properties, and project structure. It needs no Anypoint credentials and does not connect to your MuleSoft environments. You need Node.js to run the tool, but you do not need to know JavaScript or Node development.\n\n## Tell your AI agent\n\n**Codex / Claude Code / GitHub Copilot / Gemini / Cursor:**\n\n```text\nFetch and follow https://raw.githubusercontent.com/Avinava/mule-lint/master/docs/agent-setup.md\nto set up or update mule-lint in this Mule repository. Detect the agent host and existing\nconfiguration, run a read-only baseline scan, preview any proposed changes, preserve customized\nfiles, and do not modify Mule source or commit unless I approve it.\n```\n\nThat is enough for the agent to check Node.js, run the pinned CLI, explain the result, and offer only\nthe MCP, shared policy, or CI integration you need. Prefer the manual first run below when you want\nto perform the setup yourself.\n\n## First run\n\n1. Install [Node.js 20 or newer](https://nodejs.org/en/download).\n2. Open a terminal in the root of a Mule project—the directory containing `pom.xml`.\n3. Run:\n\n```bash\nnpm install -g @sfdxy/mule-lint\nmule-lint . --profile recommended\n```\n\nExample summary:\n\n```text\nSummary:\n Errors: 1\n Warnings: 5\n Infos: 5\n```\n\nStart with errors, then warnings. Info findings are advisory. See the [5-minute guide](docs/getting-started.md) if `node`, `npm`, or `mule-lint` is unfamiliar.\n\n## Useful commands\n\n```bash\n# Scan the current Mule project\nmule-lint . --profile recommended\n\n# Create an interactive report\nmule-lint . --profile recommended --format html --output mule-lint-report.html\n\n# Fail CI when errors or warnings exist\nmule-lint . --profile recommended --fail-on-warning\n\n# Validate RAML or OpenAPI\nmule-lint api validate ./src/main/resources/api\n\n# Format Mule XML (writes changes)\nmule-lint format ./src/main/mule\n```\n\nLinting is read-only. The `format` command is the only command above that changes source files; use `format --check` for a read-only preview.\n\n## What a finding means\n\n```text\nsrc/main/mule/orders-api.xml\n 31:5 error Flow \"get-order-by-id-flow\" is missing an error handler (MULE-003)\n```\n\n- `src/main/mule/orders-api.xml` is the file.\n- `31:5` is line and column.\n- `error` is the severity.\n- `MULE-003` is the stable rule ID; look it up in the [rules catalog](docs/best-practices/rules-catalog.md).\n\nThe [sample project](examples/sample-orders-system-api) produces the documentation examples and is safe to experiment with.\n\n## Choose an output\n\n| Format | Command option | Best for |\n| -------------- | -------------------------------------- | ----------------------------- |\n| Terminal table | `--format table` | A developer fixing a project |\n| HTML | `--format html --output report.html` | Exploring and sharing results |\n| SARIF | `--format sarif --output report.sarif` | Pull-request annotations |\n| JSON | `--format json` | Scripts and integrations |\n| CSV | `--format csv --output report.csv` | Spreadsheet review |\n\nSee [output formats](docs/output-formats.md) for real examples and exit codes.\n\n## Documentation\n\n- [Getting started](docs/getting-started.md)\n- [Common recipes](docs/recipes.md)\n- [Troubleshooting](docs/troubleshooting.md)\n- [CLI reference](docs/cli-reference.md)\n- [Profiles and team rollout](docs/profiles.md)\n- [Configuration](docs/configuration.md)\n- [MuleSoft practices handbook](docs/best-practices/mulesoft-best-practices.md)\n- [MCP setup for coding agents](docs/mcp-design.md)\n- [Contributor guide](CONTRIBUTING.md)\n\nThe searchable site is at