Rug CLI Installation
Rug CLI Installation¶
You can install the Rug command-line interface (CLI) using the standard developer packaging tools for your platform. We currently support installing the Rug CLI on GNU/Linux Deb and RPM distributions, Mac OS X/macOS using Homebrew, and MS Windows using Chocolatey.
Once you have it installed, continue with the Rug CLI Quick Start.
Install the Rug CLI on Mac OS X / macOS¶
Once you have Homebrew installed, it is just two easy steps:
$ brew tap atomist/tap $ brew install rug-cli
If you'd like to stay on the latest, possible unstable and un-released, version of the CLI you can install HEAD from:
$ brew upgrade --HEAD rug-cli --fetch-HEAD
Install the RUG CLI on Linux¶
We support installing via packages on Debian and RPM-based GNU/Linux distributions.
To install on a Debian-based distributions, follow the next instructions:
Grab the public GPG key for the repository:2. Add a new apt source entry:
$ wget -qO - 'https://atomist.jfrog.io/atomist/api/gpg/key/public' | sudo apt-key add -3. Update the metadata:
$ echo "deb https://atomist.jfrog.io/atomist/debian $(lsb_release -c -s) main" | sudo tee /etc/apt/sources.list.d/atomist.list4. Install the CLI:
$ sudo apt-get update
$ sudo apt-get install rug-cli
Note about the JDK 8 requirement:
Rug and the CLI require Java 8. Until Rug CLI 0.22, the package would try to automatically install the appropriate JDK but different people install Java differently on their machine. Therefore, starting with Rug CLI 0.22, the package only suggests to install the dependency and emits the following message when running the CLI without a proper Java 8 found:
$ rug JAVA_HOME not set and cannot find javac to deduce location, please set JAVA_HOME.
In that case, you must ensure you set the
JAVA_HOME variable for your system
so that it points to a valid Java 8 JDK directory. On recent, Debian/Ubuntu
distributions, you can simply run
sudo apt-get install openjdk-8-jdk. On older
distributions, either install Java 8 manually and set the according variable,
or try the following instructions:
$ sudo add-apt-repository ppa:openjdk-r/ppa $ sudo apt-get update $ sudo apt-get install openjdk-8-jdk
To install on a RedHat-based distributions, follow the next instructions:
Add a new yum repository:
$ cat <<EOF | sudo tee /etc/yum.repos.d/atomist.repo [Atomist] name=Atomist baseurl=https://atomist.jfrog.io/atomist/yum/ enabled=1 gpgcheck=0 EOF
Install the CLI:
$ sudo yum install rug-cli
The only required dependency is the JDK version 8 or later.
Install the RUG CLI on Windows¶
The following steps have been tested on Windows 10, your mileage may vary.
Install Chocolatey on your host as per the doc
Install the jdk8 dependency using chocolatey as an Administrator:
(admin) C:\ > choco install jdk8
Then, install the CLI using Chocolatey as an administrator:
(admin) C:\ > choco install rug-cli -s "'https://atomist.jfrog.io/atomist/api/nuget/nuget'"
The CLI will be installed in
%programdata%\Chocolatey\lib\rug-cliand available to your
%PATH%. You can now run as a normal user:
(user) C:\ > rug --version rug 0.13.0 atomist/rug-cli.git (git revision 2cde8f5: last commit 2016-12-01)
Notice, you will find the
.atomistdirectory for settings and artifacts in
You can keep your Rug CLI up to dat by regularly upgrading:
(admin) C:\ > choco upgrade rug-cli -s "'https://atomist.jfrog.io/atomist/api/nuget/nuget'"
You can remove the Rug CLI if you no longer want it installed:
(admin) C:\ > choco uninstall rug-cli
Files and directories in
%USERPROFILE%\.atomist will not be
removed. You can safely delete that directory manually if you don't
intend to use the CLI any longer.
If you cannot install using a system-wide approach, you can rely also on downloading the CLI through a Docker image we provide.
$ docker pull atomist-docker.jfrog.io/rug-cli
Running the image as will give you the Rug shell:
$ docker run --rm -it atomist-docker.jfrog.io/rug-cli Resolving dependencies for com.atomist:rug:0.12.0 completed Initializing shell for com.atomist:rug:0.12.0 completed Press 'Tab' to complete. Type 'help' and hit 'Return' for help, and 'exit' to quit. rug →
If you want to run the CLI, the image expects you to call
rug as its first
argument. For instance:
$ docker run --rm -it atomist-docker.jfrog.io/rug-cli rug --version rug 0.23.0 https://github.com/atomist/rug-cli.git (git revision e77cf5f; last commit 2017-02-14)
Notice how the CLI stores its settings inside the container under
/home/atomist/.atomist/cli.yml. All the dependencies will be downloaded into
You can persist those on your host by providing the following argument to the
docker run command:
To use the CLI against a project on your host, you will also need to share your
project's directory with the container
working directory. For example, assuming you are currently in a Rug project:
$ docker run --rm -it \ --user $UID:`id -g` \ -v $HOME/.atomist:/home/atomist/.atomist \ -v $PWD:/home/atomist/project \ atomist-docker.jfrog.io/rug-cli \ rug
The constraint here is the limit imposed by the management of permissions between your host's user and the user defined in the container.
In the container, the CLI is not run as
root but as a regular user that
hopefully does not map any UID on your system. A possible workaround is
to switch to a different user at runtime, hence the rather ugly command line
above. Another approach is to switch to user namespace on your host.
If you are not on a supported platform, or just prefer to install the
Rug CLI yourself, you can download the Rug CLI archive, unpack it, and
simply put it its
bin directory in your
Make sure you have Java 8 or later installed. Run the following command in a terminal and make sure you get an output something like that shown.
$ java -version java version "1.8.0_66" Java(TM) SE Runtime Environment (build 1.8.0_66-b17) Java HotSpot(TM) 64-Bit Server VM (build 25.66-b17, mixed mode)
Download either the
.ziparchive from the latest Rug CLI release.
Unpack the archive in an appropriate location. Replace
VERSIONwith the version you downloaded.
$ mkdir $HOME/opt $ cd $HOME/opt $ tar -x -z -f rug-cli-VERSION-bin.tar.gz $ ln -s rug-cli-VERSION rug-cli
$ mkdir $HOME/opt $ cd $HOME/opt $ unzip rug-cli-VERSION-bin.zip $ ln -s rug-cli-VERSION rug-cli
On MS Windows, download the
.zipand double-click it to extract its contents.
Add the Rug CLI
bindirectory to your
$ export PATH=$PATH:$HOME/opt/rug-cli/bin
Add the above command to your shell startup script to ensure you always will have access to the Rug CLI. On MS Windows, see How to Edit Your System Path, adding the
bindirectory of the archive you unpacked in the previous step.