Skip to content

Commit e9c247c

Browse files
author
ABaldwinHunter
committed
Update analyze command documentation
Add information about -e and --dev flags
1 parent fa9e793 commit e9c247c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ A list of available commands is accessible by running `codeclimate` or
7575
$ codeclimate help
7676

7777
Available commands:
78-
analyze [-f format]
78+
analyze [-f format] [-e engine(:channel)] <path> [--dev]
7979
console
8080
engines:disable engine_name
8181
engines:enable engine_name
@@ -90,7 +90,8 @@ Available commands:
9090

9191
The following is a brief explanation of each available command.
9292

93-
* `analyze`: Analyze all relevant files in the current working directory. All engines that are enabled in your `.codeclimate.yml` file will run, one after another. The `-f` (or `format`) argument allows you to set the output format of the analysis (using `json`, `text`, or `html`).
93+
* `analyze`: Analyze all relevant files in the current working directory. All engines that are enabled in your `.codeclimate.yml` file will run, one after another. The `-f` (or `format`) argument allows you to set the output format of the analysis (using `json`, `text`, or `html`). The `--dev` flag lets you run your own engines during
94+
development.
9495
* `console`: start an interactive session providing access to the classes within the CLI. Useful for engine developers and maintainers.
9596
* `engines:disable engine_name`: Changes the engine's `enabled:` node to be `false` in your `.codeclimate.yml` file. This engine will not be run the next time your project is analyzed.
9697
* `engines:enable engine_name`: Installs the specified engine (`engine_name`). Also changes the engine's `enabled:` node to be `true` in your `.codeclimate.yml` file. This engine will be run the next time your project is analyzed.

0 commit comments

Comments
 (0)