Machine-readable reference

Command metadata ships with the documentation.

The static docs include docs/commands.json for tooling that wants command names, modules, read-only status, examples, and high-level categories without scraping HTML.

42commands
4categories
v1metadata

42 commands shown

Diagnostics

29 commands

Diagnostics

devdoctor env

read-only

Check dotenv files and configured env rules.

Module
env
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --env-file=.envEnv file name default: .env
  • --example=.env.exampleExample env file name default: .env.example
  • --config=devdoctor.ymlDevDoctor config file name default: devdoctor.yml
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --no-secretsDisable secret scanning for this run
php devdoctor env --strict

Diagnostics

devdoctor cache

read-only

Check framework and tool cache directories, size, permissions, and Laravel artifacts.

Module
cache
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --max-size=512Maximum expected cache directory size in MiB default: 512
php devdoctor cache --max-size=512

Diagnostics

devdoctor http

read-only

Check configured HTTP URLs without making network requests.

Module
http
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --url=*Explicit URL target to validate repeatable
php devdoctor http --url=https://example.test

Diagnostics

devdoctor ports

read-only

Check local development port conflicts.

Module
ports
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --port=*Specific port to inspect repeatable
  • --ports=Comma-separated ports to inspect
  • --commonCheck built-in common development ports
  • --include-dockerAttempt to correlate Docker port usage when available
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor ports --common

Diagnostics

devdoctor php

read-only

Check PHP runtime, composer platform requirements, memory, php.ini, and Xdebug in CI.

Module
php
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --minimum-memory=128Minimum expected PHP memory_limit in megabytes default: 128
php devdoctor php --ci

Diagnostics

devdoctor node

read-only

Check Node.js project and package manager health.

Module
node
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor node

Diagnostics

devdoctor frontend

read-only

Check frontend presets and build readiness for Vite, Next.js, Nuxt, Astro, and generic frontend projects.

Module
frontend
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor frontend

Diagnostics

devdoctor flutter

read-only

Check Flutter and Dart pubspec, lockfiles, SDK constraints, dependency sources, and platform markers.

Module
flutter
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor flutter

Diagnostics

devdoctor mobile

read-only

Check native Android and iOS project markers, wrappers, debug flags, and lockfiles.

Module
mobile
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor mobile

Diagnostics

devdoctor monorepo

read-only

Check monorepo tooling, workspace lockfiles, and root package scripts.

Module
monorepo
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor monorepo

Diagnostics

devdoctor python

read-only

Check Python manifests and dependency manager health for pip, Poetry, Pipenv, uv, and Conda.

Module
python
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor python

Diagnostics

devdoctor ruby

read-only

Check Ruby and Rails manifests, lockfiles, versions, credentials, database config, and gem sources.

Module
ruby
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor ruby

Diagnostics

devdoctor go

read-only

Check Go modules, sums, workspaces, local replace directives, toolchain directives, and vendor metadata.

Module
go
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor go

Diagnostics

devdoctor rust

read-only

Check Cargo manifests, lockfiles, workspaces, toolchains, dependency sources, and release profiles.

Module
rust
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor rust

Diagnostics

devdoctor java

read-only

Check Maven, Gradle, Ant, wrappers, Java versions, risky build scripts, and Spring profile red flags.

Module
java
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor java

Diagnostics

devdoctor mcp

read-only

Check MCP server configuration files across common agent clients, secret hygiene, remote URLs, env references, supply-chain pins, optional project policies, and risky commands without starting servers.

Module
mcp
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --config=Specific MCP config file to inspect
  • --allow-command=Comma-separated stdio command names allowed by project policy
  • --deny-command=Comma-separated stdio command names denied by project policy
  • --disallow-remoteReport remote MCP servers as policy violations
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor mcp --disallow-remote --allow-command=node,npx

Diagnostics

devdoctor iac

read-only

Check Terraform, OpenTofu, and Terragrunt manifests, lockfiles, module refs, and secret hygiene.

Module
iac
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor iac

Diagnostics

devdoctor kube

read-only

Check Kubernetes manifests and Helm charts, locks, images, services, and secret hygiene.

Module
kube
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor kube

Diagnostics

devdoctor dotnet

read-only

Check .NET solutions, projects, SDK pinning, target frameworks, lock mode, and NuGet sources.

Module
dotnet
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor dotnet

Diagnostics

devdoctor cpp

read-only

Check C/C++ build files, dependency managers, compile commands, and portability risks.

Module
cpp
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor cpp

Diagnostics

devdoctor web

read-only

Check generic web entry files, asset references, public config, server hints, and port declarations.

Module
web
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor web

Diagnostics

devdoctor laravel

read-only

Check Laravel .env, APP_KEY, debug mode, APP_URL, runtime directories, and config cache.

Module
laravel
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor laravel

Diagnostics

devdoctor symfony

read-only

Check Symfony .env hygiene, APP_SECRET, runtime directories, recipe drift, and Composer scripts.

Module
symfony
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor symfony

Diagnostics

devdoctor security

read-only

Check env examples, hard-coded secrets, risky scripts, and risky Compose settings.

Module
security
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor security

Diagnostics

devdoctor composer

read-only

Check Composer project health without install/update.

Module
composer
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --no-scriptsSkip Composer script inspection
  • --no-platform-checkSkip local platform checks
  • --no-validateSkip composer validate
php devdoctor composer

Diagnostics

devdoctor db

read-only

Check database environment configuration, with optional read-only PDO connection checks.

Module
db
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --connectAttempt a read-only PDO connection check
php devdoctor db --connect

Diagnostics

devdoctor queue

read-only

Check queue environment configuration and production sync risks.

Module
queue
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor queue --strict

Diagnostics

devdoctor git

read-only

Check repository hygiene and sensitive files.

Module
git
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --require-cleanReturn an error when the worktree is dirty
  • --require-upstreamReturn an error when the current branch has no upstream
  • --scan-sensitiveScan tracked and untracked sensitive files
  • --scan-large-filesScan untracked files above the configured size threshold
  • --large-file-threshold=10MSize threshold for --scan-large-files default: 10M
php devdoctor git --require-clean

Diagnostics

devdoctor docker

read-only

Check Compose files, daemon state, ports, and containers.

Module
docker
Type
diagnostic

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --compose-file=Compose file to inspect
  • --no-daemonSkip Docker daemon checks
  • --no-containersSkip Compose container status checks
php devdoctor docker --compose-file=docker-compose.yml

Aggregates

4 commands

Aggregates

devdoctor deps

read-only

Run Composer and Node dependency diagnostics together.

Module
deps
Type
aggregate

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor deps --summary-only

Aggregates

devdoctor health

read-only

Run a broad local project health check, with ports available through --include-ports.

Module
health
Type
aggregate

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --modules=Comma-separated modules to run
  • --exclude=Comma-separated modules to exclude
  • --config=devdoctor.ymlDevDoctor config file name default: devdoctor.yml
  • --include-portsInclude common local port checks
php devdoctor health --format=json

Aggregates

devdoctor doctor

read-only

Alias for health with the same broad local project checks.

Module
health
Type
aggregate

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --modules=Comma-separated modules to run
  • --exclude=Comma-separated modules to exclude
  • --config=devdoctor.ymlDevDoctor config file name default: devdoctor.yml
  • --include-portsInclude common local port checks
php devdoctor doctor --summary-only

Aggregates

devdoctor ci

read-only

Run CI-safe diagnostics, baselines, and aggregate exit codes, with optional policy profiles.

Module
ci
Type
aggregate

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
  • --modules=Comma-separated modules to run
  • --exclude=Comma-separated modules to exclude
  • --profile=CI policy profile: local, ci, strict-ci, or security
  • --fail-on-warningsReturn a non-zero exit code for warnings
  • --no-fail-on-warningsReturn zero when diagnostics only contain warnings
  • --config=devdoctor.ymlDevDoctor config file name default: devdoctor.yml
  • --baseline=Baseline file to apply
  • --baseline-reportInclude active, suppressed, and resolved baseline fingerprint counts
  • --write-baseline=Write warning and error fingerprints to a baseline file
  • --forceAllow replacing an existing baseline file
php devdoctor ci --profile=strict-ci

Utilities

8 commands

Utilities

devdoctor presets

read-only

Detect supported project presets across ecosystems.

Module
presets
Type
utility

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table, json, or sarif default: table
  • --ciUse CI-safe behavior
  • --strictTreat warnings as errors where supported
  • --only=Comma-separated severities to render: error, warning, info
  • --summary-onlyRender module summaries without issue details
  • --no-hintsHide hints and suggested fixes from output
php devdoctor presets --format=json

Utilities

devdoctor inventory

read-only

Show detected presets, available modules, and auto-selected modules.

Module
inventory
Type
utility

Options

  • --path=.Project path to inspect default: .
  • --format=tableOutput format: table or json default: table
php devdoctor inventory --format=json

Utilities

devdoctor commands

read-only

List DevDoctor commands and their documentation metadata.

Module
commands
Type
utility

Options

  • --format=tableOutput format: table or json default: table
  • --module=Filter commands by module
  • --type=Filter commands by type
php devdoctor commands --format=json

Utilities

devdoctor version

read-only

Show the current DevDoctor version for humans or automation.

Module
version
Type
utility

Options

  • --format=tableOutput format: table or json default: table
php devdoctor version --format=json

Utilities

devdoctor explain

read-only

Explain issue codes and their built-in hints.

Module
explain
Type
utility

Arguments

  • code?Issue code to explain

Options

  • --format=tableOutput format: table or json default: table
  • --module=Filter issue codes by module
php devdoctor explain DD_ENV_FILE_MISSING --format=json

Utilities

devdoctor policy

read-only

Show DevDoctor safety and compatibility policy.

Module
policy
Type
utility

Options

  • --format=tableOutput format: table or json default: table
php devdoctor policy --format=json

Utilities

devdoctor support-bundle

read-only

Print redacted support context without writing files.

Module
support-bundle
Type
utility

Options

  • --path=.Project path to inspect default: .
  • --format=jsonOutput format: json default: json
php devdoctor support-bundle

Utilities

devdoctor self-update

writes file

Check for a newer DevDoctor release and show or run the safest update command.

Module
updates
Type
utility

Options

  • --runExecute the suggested package-manager update command when supported
  • --format=tableOutput format: table or json default: table
php devdoctor self-update

Writers

1 commands

Writers

devdoctor init

writes file

Preview and optionally write devdoctor.yml after confirmation.

Module
config
Type
writer

Options

  • --path=.Project path to inspect default: .
  • --config=devdoctor.ymlConfig file name default: devdoctor.yml
  • --dry-runPrint generated config without writing it
  • --forceAllow replacing an existing config file
  • --ciUse CI-safe behavior
php devdoctor init --dry-run