Shard Detail

shards v0.4.0

Dependency manager for the Crystal language

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


shards:
  github: crystal-lang/shards
  version: 0.4.0

Readme

Shards

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

dependencies:
  openssl:
    github: datanoise/openssl.cr
    branch: master

development_dependencies:
  minitest:
    git: https://github.com/ysbaddaden/minitest.cr.git
    version: ~> 1.0.0

license: MIT

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

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

About

Shards will eventually supersede the current "crystal deps" command and be distributed along with the Crystal distribution.

Shards resolves and installs dependencies recursively and work is undergoing to generate a lock file for indempotent installs across different computers. Shards doesn't yet resolve conflicts when a nested dependency version is incompatible with the requirement of a top dependency.

Requirements

  • Crystal >= 0.7.7

License

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