CLI

The CLI of coursier has a number of commands to deal with dependencies and artifacts:

setup: check if your system has a JVM and the standard Scala applications, and install them if needed,
install: install applications based on Maven / Ivy dependencies,
java and java-home: install, run, and get the home directory of JVMs,
resolve: list the transitive dependencies of one or more dependencies,
fetch: fetch the artifacts of one or more dependencies,
launch: run applications based on Maven / Ivy dependencies,
bootstrap: generate convenient launchers to run them.

See below for its installation, its basic usage, and click on the links above or on the left for more details about each of its commands.

Install native launcher

The commands below install the native launcher as cs, which can be substituted to coursier in the various examples on this website.

Linux

On Linux, download and run the coursier launcher with

$ curl -Lo cs https://git.io/coursier-cli-linux &&
    chmod +x cs &&
    ./cs --help

macOS

Download and run the coursier launcher with

$ curl -Lo cs https://git.io/coursier-cli-macos &&
    chmod +x cs &&
    (xattr -d com.apple.quarantine cs || true) &&
    ./cs --help

Note the xattr command to circumvent notarization on macOS Catalina.

Alternatively, the native launcher can be installed via homebrew with

$ brew install coursier/formulas/coursier
$ cs --help

Windows

On Windows, use

> bitsadmin /transfer cs-cli https://git.io/coursier-cli-windows-exe "%cd%\cs.exe"
> .\cs --help

Install JAR-based launcher

In case you run into any issue with the native launcher, a JAR-based launcher is available.

Linux / macOS

Download and run the launcher with

$ curl -Lo coursier https://git.io/coursier-cli &&
    chmod +x coursier &&
    ./coursier --help

Note that the JAR-based launcher requires Java 8 or later to run. That is, a command like java -version should print a version >= 8.

The JAR-based launcher weights only about 25 kB and can be easily embedded as is in other projects. It downloads the artifacts required to launch coursier on the first run.

Alternatively, on macOS, the JAR-based launcher can be installed via homebrew with

$ brew install coursier/formulas/coursier
$ coursier --help

Windows

Install and run the JAR-based coursier launcher from the current directory at the Windows prompt, with

> bitsadmin /transfer downloadCoursierCli https://git.io/coursier-cli "%cd%\coursier"
> bitsadmin /transfer downloadCoursierBat https://git.io/coursier-bat "%cd%\coursier.bat"

You can then run coursier from the same directory, like

> coursier resolve io.circe:circe-core_2.12:0.10.0

Arch Linux

Install it from AUR,

$ pacaur -S coursier

FreeBSD

Install it via pkg from the Ports Collection,

$ pkg install coursier

zsh completions

If you use ZSH, simple tab-completions are available by copying the scripts/_coursier file into your completions directory, if you have one. If you do not, then you can install the completions with,

mkdir -p ~/.zsh/completion
cp scripts/_coursier ~/.zsh/completion/
echo 'fpath=(~/.zsh/completion $fpath)' >> ~/.zshrc
echo 'autoload -Uz compinit ; compinit' >> ~/.zshrc

Usage

$ ./coursier --help

lists the available coursier commands. The most notable ones are launch, and fetch. Type

$ ./coursier command --help

to get a description of the various options the command command (replace with one of the above command) accepts.

Both commands below can be given repositories with the -r or --repository option, like

-r central
-r sonatype:snapshots
-r https://oss.sonatype.org/content/repositories/snapshots
-r "ivy:https://repo.typesafe.com/typesafe/ivy-releases/[organisation]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]"

central and ivy2local correspond to Maven Central and ~/.ivy2/local. These are used by default unless the --no-default option is specified.

Repositories starting with ivy: are assumed to be Ivy repositories, specified with an Ivy pattern, like ivy:https://repo.typesafe.com/typesafe/ivy-releases/[organisation]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]. Else, a Maven repository is assumed.

To set credentials for a repository, pass a user and password in its URL, like

-r https://user:pass@nexus.corp.com/content/repositories/releases

Launcher URLs

Latest launchers

The various git.io shortened URLs above redirect to the latest launchers from the launchers repository:

OS	Short URL	redirects to
Linux	https://git.io/coursier-cli-linux	https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-linux
macOS	https://git.io/coursier-cli-macos	https://github.com/coursier/launchers/raw/master/cs-x86_64-apple-darwin
Windows	https://git.io/coursier-cli-windows-exe	https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-win32.exe
Any (needs JVM)	https://git.io/coursier-cli	https://github.com/coursier/coursier/raw/gh-pages/coursier (gh-pages branch of coursier repository rather than launchers repository)
Any (needs JVM)		https://github.com/coursier/launchers/raw/master/coursier (same launcher as above)

Specific versions

To download specific versions of the launcher, download them from GitHub release assets:

OS	URL	Since version
Linux	https://github.com/coursier/coursier/releases/download/v2.0.0-RC6-11/cs-x86_64-pc-linux	`2.0.0-RC3-1`
macOS	https://github.com/coursier/coursier/releases/download/v2.0.0-RC6-11/cs-x86_64-apple-darwin	`2.0.0-RC3-1`
Windows	https://github.com/coursier/coursier/releases/download/v2.0.0-RC6-11/cs-x86_64-pc-win32.exe	`2.0.0-RC6`
Any (needs JVM)	https://github.com/coursier/coursier/releases/download/v2.0.0-RC6-11/coursier	`1.1.0-M9`
Any (needs JVM)	https://github.com/coursier/coursier/raw/v1.1.0-M9/coursier (up to version `1.1.0-M9`)	Invalid for newest versions