coala(1)

NAME
coala

SYNOPSIS
 coala [-h] [-v] [-C] [--ci] [--json] [--format [STR]] [-c FILE] [-F] [-I]
      [-s [FILE]] [--disable-caching] [--flush-cache] [--no-autoapply-warn]
      [-b NAME [NAME ...]] [-f FILE [FILE ...]] [-i FILE [FILE ...]]
      [--limit-files FILE [FILE ...]] [-d DIR [DIR ...]] [-V] [-L ENUM]
      [-m ENUM] [-N] [-B] [-l LANG [LANG ...]] [-p LANG [LANG ...]] [-D]
      [--show-details] [--log-json] [-o FILE] [-r [RELPATH]]
      [-S SETTING [SETTING ...]] [-a] [-j JOBS] [-n]
      [TARGETS [TARGETS ...]]

DESCRIPTION
    :target: https://coala.io/
=====
:emphasis:`"Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live."` ― `John F. Woods <http://ruby.zigzo.com/2014/08/01/who-said-that-one-violent-psychopath-quote/>`_
=====
|Linux Build Status| |Windows Build status| |macOS Build Status|
|codecov.io| |Documentation Status| |AGPL|
=====
`coala <https://coala.io>`_ provides a unified interface for linting and fixing code with a single configuration file, regardless of the programming languages used. You can use coala from within your favorite editor, integrate it with your CI, get the results as JSON, or customize it to your needs with its flexible configuration syntax.
coala supports popular programming languages including **Python**, **C/C++**, **Java**, **JavaScript**, **CSS**, and `several others <http://coala.io/#!/languages>`_ out of the box.
`Install coala <http://coala.io/#!/home#installation>`_ | `Get Involved <http://coala.io/#!/getinvolved>`_ | `Chat <https://coala.io/chat>`_ | `Roadmap <https://projects.coala.io>`_ | `Blog <http://blog.coala.io>`_ | `Twitter <https://www.twitter.com/coala_io>`_
   :target: https://circleci.com/gh/coala/coala
   :target: https://ci.appveyor.com/project/coala/coala/branch/master
   :target: https://travis-ci/coala/coala
   :target: https://codecov.io/github/coala/coala?branch=master
   :target: http://docs.coala.io/
   :target: https://www.gnu.org/licenses/agpl-3.0.html

OPTIONS
  TARGETS sections to be executed exclusively
  -h, --help
                        show this help message and exit
  -v, --version
                        show program's version number and exit
  -C, --non-interactive
                        run coala in non interactive mode
  --ci continuous integration run, alias for `--non-
                        interactive`
  --json mode in which coala will display output as json
  --format [STR] output results with a custom format string, e.g.
                        "Message: {message}"; possible placeholders: id,
                        origin, file, line, end_line, column, end_column,
                        severity, severity_str, message, message_base,
                        message_arguments, affected_code, source_lines
  -c FILE, --config FILE
                        configuration file to be used, defaults to .coafile
  -F, --find-config
                        find .coafile in ancestors of the working directory
  -I, --no-config
                        run without using any config file
  -s [FILE], --save [FILE]
                        save used arguments to a config file to a .coafile,
                        the given path, or at the value of -c
  --disable-caching
                        run on all files even if unchanged
  --flush-cache rebuild the file cache
  --no-autoapply-warn
                        turn off warning about patches not being auto
                        applicable
  -b NAME [NAME ...], --bears NAME [NAME ...]
                        names of bears to use
  -f FILE [FILE ...], --files FILE [FILE ...]
                        files that should be checked
  -i FILE [FILE ...], --ignore FILE [FILE ...]
                        files that should be ignored
  --limit-files FILE [FILE ...]
                        filter the `--files` argument's matches further
  -d DIR [DIR ...], --bear-dirs DIR [DIR ...]
                        additional directories which may contain bears
  -V, --verbose
                        alias for `-L DEBUG`
  -L ENUM, --log-level ENUM
                        set log output level to DEBUG/INFO/WARNING/ERROR,
                        defaults to INFO
  -m ENUM, --min-severity ENUM
                        set minimal result severity to INFO/NORMAL/MAJOR
  -N, --no-color
                        display output without coloring (excluding logs)
  -B, --show-bears
                        list all bears
  -l LANG [LANG ...], --filter-by-language LANG [LANG ...]
                        filters `--show-bears` by the given languages
  -p LANG [LANG ...], --show-capabilities LANG [LANG ...]
                        show what coala can fix and detect for the given
                        languages
  -D, --show-description
                        show bear descriptions for `--show-bears`
  --show-details show bear details for `--show-bears`
  --log-json output logs as json along with results (must be called
                        with --json)
  -o FILE, --output FILE
                        write results to the given file (must be called with
                        --json)
  -r [RELPATH], --relpath [RELPATH]
                        return relative paths for files (must be called with
                        --json)
  -S SETTING [SETTING ...], --settings SETTING [SETTING ...]
                        arbitrary settings in the form of section.key=value
  -a, --apply-patches
                        apply all patches automatically if possible
  -j JOBS, --jobs JOBS
                        number of jobs to use in parallel
  -n, --no-orig
                        don't create .orig backup files before patching

LICENSE
 AGPL-3.0

MAINTAINER(S)
 Lasse Schuirmann, Fabian Neuschmidt, Mischa Krüger

SEE ALSO
 Online documentation: http://coala.io/