A static code analysis tool linter linter-plugin
0.14.3 Latest release released


Code style linter for Crystal

(a single-celled animal that catches food and moves about by extending fingerlike projections of protoplasm)


Ameba is a static code analysis tool for the Crystal language. It enforces a consistent Crystal code style, also catches code smells and wrong code constructions.

See also Roadmap.


Run ameba binary within your project directory to catch code issues:

$ ameba
Inspecting 107 files


[W] Lint/UnusedArgument: Unused argument `location`
> source.issues.each do |e, location|

[W] Lint/UselessAssign: Useless assignment to variable `s`
> return s += issues.size

Finished in 542.64 milliseconds
129 inspected, 2 failures

Watch a tutorial

🎬 Watch the LuckyCast showing how to use Ameba

Run in parallel

Starting from 0.31.0 Crystal supports parallelism. It allows to run linting in parallel too. In order to take advantage of this feature you need to build ameba with preview_mt support:

$ crystal build src/ -Dpreview_mt -o bin/ameba
$ make install

Some quick benchmark results measured while running Ameba on Crystal repo:

$ CRYSTAL_WORKERS=1 ameba #=> 29.11 seconds
$ CRYSTAL_WORKERS=2 ameba #=> 19.49 seconds
$ CRYSTAL_WORKERS=4 ameba #=> 13.48 seconds
$ CRYSTAL_WORKERS=8 ameba #=> 10.14 seconds


As a project dependency:

Add this to your application's shard.yml:

    github: crystal-ameba/ameba
    version: ~> 0.13.0

Build bin/ameba binary within your project directory while running shards install.

You may also want to use it on Travis:

# .travis.yml
language: crystal
  - shards install
  - crystal spec
  - crystal bin/

Using this config Ameba will inspect files just after the specs run. Travis will also fail the build if some problems detected.


$ brew tap veelenga/tap
$ brew install ameba


Build the image:

$ docker build -t crystal-ameba/ameba .

To use the resulting image on a local source folder, mount the current (or target) directory into /src:

$ docker run -v $(pwd):/src crystal-ameba/ameba

Also available on DockerHub:

From sources

$ git clone && cd ameba
$ make install


Default configuration file is .ameba.yml. It allows to configure rule properties, disable specific rules and exclude sources from the rules.

Generate new file by running ameba --gen-config.


List of sources to run Ameba on can be configured globally via:

  • Globs section - an array of wildcards (or paths) to include to the inspection. Defaults to %w(**/*.cr !lib), meaning it includes all project files with *.cr extension except those which exist in lib folder.
  • Excluded section - an array of wildcards (or paths) to exclude from the source list defined by Globs. Defaults to an empty array.

In this example we define default globs and exclude src/compiler folder:

  - **/*.cr
  - !lib

  - src/compiler

Specific sources can be excluded at rule level:

  - src/server/
  - src/server/


One or more rules, or a one or more group of rules can be included or excluded via command line arguments:

$ ameba --only   Lint/Syntax # runs only Lint/Syntax rule
$ ameba --only   Style,Lint  # runs only rules from Style and Lint groups
$ ameba --except Lint/Syntax # runs all rules except Lint/Syntax
$ ameba --except Style,Lint  # runs all rules except rules in Style and Lint groups

Or through the configuration file:

  Enabled: false

Explain issues

Ameba allows you to dig deeper into an issue, by showing you details about the issue and the reasoning by it being reported.

To be convenient, you can just copy-paste the PATH:line:column string from the report and paste behind the ameba command to check it out.

$ ameba crystal/command/           # show explanation for the issue
$ ameba --explain crystal/command/ # same thing

Inline disabling

One or more rules or one or more group of rules can be disabled using inline directives:

# ameba:disable Style/LargeNumbers
time = Time.epoch(1483859302)

time = Time.epoch(1483859302) # ameba:disable Style/LargeNumbers, Lint/UselessAssign

time = Time.epoch(1483859302) # ameba:disable Style, Lint

Editors & integrations

Credits & inspirations


  • veelenga Vitalii Elenhaupt - creator, maintainer
  github: crystal-ameba/ameba
  version: ~> 0.14.3
License MIT
Crystal >= 0.35.0


Dependencies 0

Development Dependencies 0

Dependents 208

Show all 208 dependents

Other repos 1

Last synced .
search fire star recently