SHARD.YML(5) File Formats SHARD.YML(5) (NAME) shard.yml - shards(1) (DESCRIPTION) shard.yml YAML shards shard . name version . shard.yml . ( ) . (FORMAT) shard.yml YAML UTF-8 . (mapping) . (space) . YAML (sequences) ( Failsafe). (REQUIRED ATTRIBUTES) name ( ). o . o . o (a-z) . o crystal . o (0-9) . o (underscore) (dash) . o . : minitest mysql2 battery-horse. version ( ). o . o . o ' (prerelease)' . : 1.2.3 2.0.0.1 1.0.0.alpha 2.0.0-rc1 2016.09. Shards (Semantic Versioning) (Calendar Versioning) . (OPTIONAL ATTRIBUTES) authors () ( ). o . o (< >) . : authors: - Ary - Julien Portalier crystal (crystal). ( ). . shards . . . dependencies.version : o : < <= > >= != ~>. o "*" ( ). o . ( ) : >= x.y.z ">= x.y.z" . (major) () . : crystal: ">= 0.35, < 2.0" dependencies (). () () (resolver) . : dependencies: minitest: github: ysbaddaden/minitest.cr version: 0.1.0 development_dependencies (). . . . : development_dependencies: minitest: github: ysbaddaden/minitest.cr version: ~> 0.1.3 description ( ). documentation (URL) (). executables (). ( ) bin Shard ( POSIX). bin . postinstall Shards . --skip-executables . : executables: - micrate - icr homepage (URL) (). libraries shard (link) (). shard . shard . . soname ( libsqlite3 /usr/lib/libsqlite3.so.0.8.6) . : o . o "*" . o : < <= > >= != ~>. libraries: libQt5Gui: "*" libQt5Help: "~> 5.7" libQtBus: ">= 4.8" license SPDX (URL) ( ). (OSI) SPDX . : Apache-2.0 GPL-3.0-or-later Apache-2.0 OR MIT Apache-2.0 WITH Swift-exception . repository (URL) ( ). URL (VCS) . http/https VCS git . . shard ( ) . : repository: "https://github.com/crystal-lang/shards" scripts (script hooks) . postinstall . Shards . . postinstall postinstall . C . lib/foo Shard foo. : scripts: postinstall: cd src/libfoo && make targets (targets) (). () () . bin . : targets: server: main: src/server/cli.cr worker: main: src/worker.cr bin/server src/server/cli.cr bin/worker src/worker.cr . main (). (DEPENDENCY ATTRIBUTES) (resolver) . path git github gitlab bitbucket codeberg . path (). (symlink) . version . git (URL) (). SSH GIT HTTPS. ( shard.yml ) ( v1.2.3) . (version tag branch commit) . Shards HEAD . : git: git://git.example.org/crystal-library.git github user/repo (). git . : github: ysbaddaden/minitest.cr gitlab user/repo (). git . gitlab.com . git . : gitlab: thelonlyghost/minitest.cr bitbucket user/repo (). git . : bitbucket: tom/library codeberg user/repo (). git . : codeberg: tom/library hg (URL) (). SSH HTTPS. ( shard.yml ) ( v1.2.3) . (version tag branch bookmark commit) . Shards @ tip . : hg: fossil Fossil (). Fossil SSH HTTPS. Fossil ( shard.yml ) Fossil ( v1.2.3) . (version tag branch commit) . Shards trunk . : fossil: version (). o . o "*" ( ). Shards ( HEAD ) . o : < <= > >= != ~>. o . : 1.2.3 >= 1.0.0 >= 1.0.0, < 2.0 ~> 2.0. >= 1.0.0 ~> . (major): o ~> 0.3.5 >= 0.3.5 and < 0.4.0 . o ~> 2.0.3 >= 2.0.3 and < 2.1 . o ~> 2.1 >= 2.1 and < 3.0 . o ~> 0.3 >= 0.3 and < 1.0 . o ~> 1 >= 1.0 and < 2.0 . (Note) 2.1.0-dev 2.1.0 ~> 2.0.3 .3 2.0 . branch Fossil (). commit Fossil (). tag Fossil (). bookmark (bookmark) (). (EXAMPLES) shard.yml shards 1.2.3 : name: shards version: 1.2.3 crystal: '>= 0.35.0' authors: - Julien Portalier license: MIT description: | Dependency manager for the Crystal Language dependencies: openssl: github: datanoise/openssl.cr branch: master development_dependencies: minitest: git: https://github.com/ysbaddaden/minitest.cr.git version: "~> 0.1.0" libraries: libgit2: ~> 0.24 scripts: postinstall: make ext targets: shards: main: src/shards.cr (AUTHOR) Julien Portalier . (SEE ALSO) shards(1) shards 0.19.1 2025-01-23 SHARD.YML(5)