Skip to main content

Command Line Interface

To use the package as a command-line tool, run:

$ dcm <command> lib

It will produce a result in one of the supported formats:

  • Console
  • GitHub
  • Checkstyle
  • Codeclimate
  • HTML
  • JSON

Available commands

The following table shows which commands you can use with the tool:

CommandExample of useShort description
analyzedcm analyze libReports code metrics and rules violations.
fixdcm fix libFixes issues produced by dcm analyze command.
check-exports-completenessdcm check-exports-completeness libChecks that an exported API exports all used types.
check-unnecessary-nullabledcm check-unnecessary-nullable libChecks unnecessary nullable parameters.
check-unused-filesdcm check-unused-files libChecks unused *.dart files.
check-unused-l10ndcm check-unused-l10n libChecks unused localization in *.dart files.
check-unused-codedcm check-unused-code libChecks unused code in *.dart files.

For additional help on any of the commands:

$ dcm <command> --help

Multi-package repositories usage

If you run a command from the root of a multi-package repository (a.k.a. monorepo), it'll pick up analysis_options.yaml files correctly.

Additionally, if you use Melos, you can add custom command to the melos.yaml.

run: |
melos exec -c 1 --ignore="*example*" -- \
dcm analyze lib
description: |
Run DCM in all packages.
- Note: you can also rely on your IDEs Dart Analysis / Issues window.