shards v0.14.1

Dependency manager for the Crystal language
  • v0.14.1 - March 10, 2021
  • v0.14.0 - February 23, 2021
  • v0.13.0 - January 21, 2021
  • v0.12.0 - August 5, 2020
  • v0.11.1 - June 8, 2020



Dependency manager for the Crystal language.


Crystal applications and libraries are expected to have a shard.yml file at their root looking like this:

name: shards
version: 0.1.0

    github: datanoise/
    branch: master

    version: ~> 0.3.1

license: MIT

When libraries are installed from Git repositories, the repository is expected to have version tags following a semver-like format, prefixed with a v. Examples: v1.2.3, v2.0.0-rc1 or v2017.04.1.

Please see the SPEC for more details about the shard.yml format.


Shards is usually distributed with Crystal itself (e.g. Homebrew and Debian packages). Alternatively, a shards package may be available for your system.

You can download a source tarball from the same page (or clone the repository) then run make release=1and copy bin/shards into your PATH. For example /usr/local/bin.

You are now ready to create a shard.yml for your projects (see details in SPEC). You can type shards init to have an example shard.yml file created for your project.

Run shards install to install your dependencies, which will lock your dependencies into a shard.lock file. You should check both shard.yml and shard.lock into version control, so further shards install will always install locked versions, achieving reproducible installations across computers.

Run shards --help to list other commands with their options.

Happy Hacking!


These requirements are only for compiling Shards.

  • Crystal

    Please refer to for instructions for your operating system.

  • libyaml

    On Debian/Ubuntu Linux you may install the libyaml-dev package.

    On Mac OS X you may install it using homebrew with brew install libyaml then make sure to have /usr/local/lib in your LIBRARY_PATH environment variable (eg: export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH"). Please adjust the path per your Homebrew installation.

  • asciidoctor

    Needed for building manpages.


Licensed under the Apache License, Version 2.0. See LICENSE for details.

github statistic
  • 664
  • 3
  • 82
  • 59
  • 12 days ago
  • May 20, 2015


Synced at

Mon, 21 Jun 2021 15:34:45 GMT