Deprecation Notice

Please note that this tool has already reached its End of Support and although we are not preventing you from its usage at your own risk, we would like to encourage you to use alternative options with enhanced functionality (further examples can be found also in our documentation). Use of these alternative options will guarantee you the fully supported troubleshooting, new functionalities and generally the best service possible.

In case you are heavily depending on the current tooling you have in place, you can download the source code from this repository or fork it and extend according to your needs. This should give you more flexibility in maintaining the tool on your own but without any guarantee and any further support from the GoodData side.

GoodData CL Tool

This is GoodData data integration toolkit. The toolkit contains data modeling, transformation and loading utilities that work on top of the GoodData REST APIs.

Unless you wish to participate in development of the tool, you should choose the easier binary install.

Building from sources

See separate Windows and Unix instructions.

UNIX/Mac installation

1. download the code and unpack (or git clone this repository):

2. make sure you have Apache Maven installed:

    $ which mvn
    /usr/bin/mvn
   

3. create the M2_HOME environment variable that points to the Maven root directory

    $ export M2_HOME=path-to-your-maven-installation-dir
   

4. Make sure that your JAVA_HOME environment variable points to your Java installation directory. Please note that only the Java versions 1.5 and 1.6 are currently supported.

5. build the toolkit:

    $ mvn install
   

6. build the client distribution

    $ cd cli-distro
    $ mvn assembly:assembly
   

7. unpack one of the distributions that have been built in the cli-distro/target subdirectory:

   • gooddata-cl-1.1.0-SNAPSHOT.tar.gz
   • gooddata-cl-1.1.0-SNAPSHOT.zip

8. run the gdi.sh without arguments to get help from the unpacked distribution:

    $ ./bin/gdi.sh
    usage: GdcDI
     -h,--host <arg>       GoodData host
     -p,--password <arg>   GoodData password
     -u,--username <arg>   GoodData username
    [...]
   

Windows installation

1. download the code and unzip

2. make sure you have Apache Maven installed:

    C:\>mvn --version
    Apache Maven 2.2.1 (r801777; 2009-08-06 21:16:01 +0200)
    [...]
   

3. create the M2_HOME environment variable that points to the Maven root directory

    C:\> SET M2_HOME=path-to-your-maven-installation-dir
   

4. Make sure that your JAVA_HOME environment variable points to your Java installation directory. Please note that only the Java versions 1.5 and 1.6 are currently supported.

5. build the toolkit:

    C:\>mvn install
   

6. build the client distribution

    C:\>cd cli-distro
    C:\>mvn assembly:assembly
   

7. unpack one of the distributions that have been built in the cli-distro/target subdirectory:

   • gooddata-cl-1.1.0-SNAPSHOT.tar.gz
   • gooddata-cl-1.1.0-SNAPSHOT.zip

8. run the gdi.bat without arguments to get help from the unpacked distribution:

    bin\gdi.bat
    usage: GdcDI
     -h,--host <arg>       GoodData host
     -p,--password <arg>   GoodData password
     -u,--username <arg>   GoodData username
    [...]