codeclimate
is a command line interface for the Code Climate analysis
platform. It allows you to run Code Climate engines on your local machine inside
of Docker containers.
The Code Climate CLI is distributed and run as a
Docker image. The engines that perform the actual
analyses are also Docker images. To support this, you must have Docker installed
and running locally. We also require that the Docker daemon supports connections
on the default Unix socket /var/run/docker.sock
.
On OS X, we recommend using Docker Machine.
docker pull codeclimate/codeclimate
docker run \
--interactive --tty --rm \
--env CODE_PATH="$PWD" \
--volume "$PWD":/code \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume /tmp/cc:/tmp/cc \
codeclimate/codeclimate help
The above is very transparent. It's clear what's happening, and any changes required to work with your specific Docker setup can be discovered easily. That said, it can be unwieldy to invoke such a command on a regular basis.
For this reason, we also provide packages that include a small wrapper script for the above invocation:
brew tap codeclimate/formulae
brew install codeclimate
To update the brew package, use brew update
first:
brew update
brew upgrade codeclimate
curl -L https://github.com/codeclimate/codeclimate/archive/master.tar.gz | tar xvz
cd codeclimate-* && sudo make install
A list of available commands is accessible by running codeclimate
or
codeclimate help
.
$ codeclimate help
Available commands:
analyze [-f format]
console
engines:disable engine_name
engines:enable engine_name
engines:install
engines:list
engines:remove
help
init
validate-config
version
The following is a brief explanation of each available command.
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
(orformat
) argument allows you to set the output format of the analysis (usingjson
ortext
).console
: start an interactive session providing access to the classes within the CLI. Useful for engine developers and maintainers.engines:disable engine_name
: Changes the engine'senabled:
node to befalse
in your.codeclimate.yml
file. This engine will not be run the next time your project is analyzed.engines:enable engine_name
: Installs the specified engine (engine_name
). Also changes the engine'senabled:
node to betrue
in your.codeclimate.yml
file. This engine will be run the next time your project is analyzed.engines:install
: Compares the list of engines in your.codeclimate.yml
file to those that are currently installed, then installs any missing engines.engines:list
: Lists all available engines in the Code Climate Docker Hub.engines:remove engine_name
: Removes an engine from your.codeclimate.yml
file.help
: Displays a list of commands that can be passed to the Code Climate CLI.init
: Generates a new.codeclimate.yml
file in the current working directory.validate-config
: Validates the.codeclimate.yml
file in the current working directory.version
: Displays the current version of the Code Climate CLI.
See LICENSE