shards
Shards
Dependency manager for the Crystal language.
Usage
Crystal applications and libraries are expected to have a shard.yml
file
at their root looking like this:
name: shards
version: 0.1.0
dependencies:
openssl:
github: datanoise/openssl.cr
branch: master
development_dependencies:
minitest:
git: https://github.com/ysbaddaden/minitest.cr.git
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.
Install
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 CRFLAGS=--release
and 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!
Requirements
These requirements are only for compiling Shards.
-
Crystal
Please refer to http://crystal-lang.org/docs/installation 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 yourLIBRARY_PATH
environment variable (eg:export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH"
). Please adjust the path per your Homebrew installation.
License
Licensed under the Apache License, Version 2.0. See LICENSE for details.