Builds the specified <targets> in bin path. If no targets are specified, all are built. This command ensures all dependencies are installed, so it is not necessary to run shards install before.

All <build_options> following the command are delegated to crystal build.

Verifies that all dependencies are installed and requirements are satisfied.

Exit status:

0

1

Initializes a default shard.yml in the current folder.

Resolves and installs dependencies into the lib folder. If not already present, generates a shard.lock file from resolved dependencies, locking version numbers or Git commits.

Reads and enforces locked versions and commits if a shard.lock file is present. The install command may fail if a locked version doesn’t match a requirement, but may succeed if a new dependency was added, as long as it doesn’t generate a conflict, thus generating a new shard.lock file.

--frozen

--without-development

--production

--skip-postinstall

--skip-executables

Lists the installed dependencies and their versions.

Specifying --tree arranges nested dependencies in a tree, instead of a flattened list.

Resolves dependencies and creates or updates the shard.lock file as per the install command, but never installs the dependencies.

Specifying --update follows the same semantics as the update command.

Lists dependencies that are outdated.

When --pre is specified, pre-release versions are also considered.

Removes unused dependencies from lib folder.

Resolves and updates all dependencies into the lib folder, whatever the locked versions in the shard.lock file. Eventually generates a new shard.lock file.

Specifying shards will update these dependencies only, trying to be as conservative as possible with other dependencies, respecting the locked versions in the shard.lock file.

Prints the current version of the shard located at path (defaults to current directory).

Prints the version of shards.

Prints usage synopsis.

Disables colored output.

Don’t update remote repositories, use the local cache only.

Decreases the log verbosity, printing only warnings and errors.

Increases the log verbosity, printing all debug statements.

Allows general options to be passed in as environment variable. Example: SHARDS_OPTS="--no-color" shards update

Defines the cache location. In this folder, shards stores local copies of remote repositories. Defaults to .cache/shards in the home directory ($XDG_CACHE_HOME or $HOME) or the current directory.

Defines the location where dependecies are installed. Defaults to lib.

Defines the location where executables are installed. Defaults to bin.

Defines the crystal version that dependencies should be resolved against. Defaults to the output of crystal env CRYSTAL_VERSION.

Defines an alternate location of shard.override.yml.

Describes a shard project including its dependencies. See shard.yml(5) for documentation.

Allows overriding the source and restriction of dependencies. An alternative location can be configured with the env var SHARDS_OVERRIDE.

The file contains a YAML document with a single dependencies key. It has the same semantics as in shard.yml. Dependency configuration takes precedence over the configuration in shard.yml or any dependency’s shard.yml.

Use cases are local working copies, forcing a specific dependency version despite mismatching constraints, fixing a dependency, checking compatibility with unreleased dependency versions.

Lockfile that stores information about the installed versions.

If your shard builds an application, shard.lock should be checked into version control to provide reproducible dependency installs.

If it is only a library for other shards to depend on, shard.lock should not be checked in, only shard.yml. It’s good advice to add it to .gitignore.