sdmx-dl
GitHub Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Installation

Requirements

sdmx-dl CLI runs on any operating systems that support the Java VM (Virtual Machine) such as Microsoft Windows, Solaris OS, Apple macOS, Ubuntu and other various Linux distributions.

It requires a Java SE Runtime Environment (JRE) version 8 or later to run on such as OpenJDK. You can download a free, binary distribution of the OpenJDK at one of the following provider: Zulu JDK, Adoptium, Amazon Corretto.

Automatic installation

The easiest way of installing the CLI is to use a package manager.
Each operating system has its own manager. See the list below for specific instructions.

scoop bucket add nbbrd https://github.com/nbbrd/scoop-nbbrd.git
scoop install sdmx-dl

jbang sdmx-dl@nbbrd <command> [<args>]

jbang com.github.nbbrd.sdmx-dl:sdmx-dl-cli:RELEASE:bin <command> [<args>]

brew install nbbrd/tap/sdmx-dl

jbang sdmx-dl@nbbrd <command> [<args>]

jbang com.github.nbbrd.sdmx-dl:sdmx-dl-cli:RELEASE:bin <command> [<args>]

brew install nbbrd/tap/sdmx-dl

jbang sdmx-dl@nbbrd <command> [<args>]

jbang com.github.nbbrd.sdmx-dl:sdmx-dl-cli:RELEASE:bin <command> [<args>]

docker run -v `pwd`:/ws --workdir=/ws jbangdev/jbang-action sdmx-dl@nbbrd <command> [<args>]

docker run -v `pwd`:/ws --workdir=/ws quay.io/jbangdev/jbang-action sdmx-dl@nbbrd <command> [<args>]

- uses: jbangdev/jbang-action@v0.98.0
  with:
    trust: https://github.com/nbbrd/jbang-catalog
    script: sdmx-dl@nbbrd
    scriptargs: "<command> [<args>]"

- uses: jbangdev/jbang-action@v0.98.0
  with:
    script: com.github.nbbrd.sdmx-dl:sdmx-dl-cli:RELEASE:bin
    scriptargs: "<command> [<args>]"

<plugin>
  <groupId>dev.jbang</groupId>
  <artifactId>jbang-maven-plugin</artifactId>
  <version>0.0.7</version>
  <executions>
    <execution>
      <id>run</id>
      <phase>process-resources</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <trusts>
          <trust>https://github.com/nbbrd/jbang-catalog</trust>
        </trusts>
        <script>sdmx-dl@nbbrd</script>
        <args>
          <arg>...</arg>
        </args>
      </configuration>
    </execution>
  </executions>
</plugin>

<plugin>
  <groupId>dev.jbang</groupId>
  <artifactId>jbang-maven-plugin</artifactId>
  <version>0.0.7</version>
  <executions>
    <execution>
      <id>run</id>
      <phase>process-resources</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <script>com.github.nbbrd.sdmx-dl:sdmx-dl-cli:RELEASE:bin</script>
        <args>
          <arg>...</arg>
        </args>
      </configuration>
    </execution>
  </executions>
</plugin>

mvn dependency:copy -Dartifact=com.github.nbbrd.sdmx-dl:sdmx-dl-cli:RELEASE:jar:bin -DoutputDirectory=. -Dmdep.stripVersion -q
java -jar sdmx-dl-cli-bin.jar <command> [<args>]
plugins {
  id 'dev.jbang' version '0.2.0'
}

Manual installation

The manual installation of the CLI is straighforward:

  1. Download the latest jar binary (sdmx-dl-cli-_VERSION_-bin.jar) at:
    https://github.com/nbbrd/sdmx-dl/releases/latest
  2. Copy this jar (i.e. _JAR_) to any folder on your system (i.e. _DIR_)
  3. Create launchers in the installation directory:
    java -jar "_DIR_\_JAR_" setup launcher -t BASH -o "_DIR_\sdmx-dl"
    java -jar "_DIR_\_JAR_" setup launcher -t CMD -o "_DIR_\sdmx-dl.bat"
    java -jar "_DIR_\_JAR_" setup launcher -t PS1 -o "_DIR_\sdmx-dl.ps1"
  4. Add launchers directory (_DIR_) in system path:
    https://gist.github.com/nex3/c395b2f8fd4b02068be37c961301caa7

Zero installation

The CLI is a single executable jar, so it doesn’t need to be installed to be used.
To use the CLI without installing it:

  1. Download the latest jar binary (sdmx-dl-cli-_VERSION_-bin.jar) at:
    https://github.com/nbbrd/sdmx-dl/releases/latest
  2. Run this jar by calling:
    java -jar sdmx-dl-cli-_VERSION_-bin.jar <command> [<args>]

Troubleshooting

If the launching of sdmx-dl fails, you can try the following operations in a terminal:

  1. Check if Java is properly installed:
    java -version
  2. Check if sdmx-dl is available:
    sdmx-dl --version