Install the Domino Command Line Interface (CLI)

The Domino Command Line Interface (CLI) is a powerful tool that allows you to manage your Domino Environment from the command line. It can be used to perform various tasks, such as creating and deleting Projects, backup and restoring Projects, and downloading files.

This guide provides instructions to install the Domino CLI on your system. Instructions are provided for both graphical and headless installations.

Headless vs. graphical installation

Depending on your use case, you can either go for a Headless or Graphical installation:

  • Headless installation is an installation of the Domino CLI on a server or machine that does not have a graphical user interface (GUI).

    This is commonly done for machines that are used to automate tasks or run Domino CLI tasks in a server environment or on a Domino Workspace.

  • Graphical installation is an installation of the Domino CLI on a machine that has a GUI. This is the best option for users who want to use the Domino CLI with a graphical interface.

Install the Domino CLI using graphical mode

Step 1: Download the CLI installer

In the top navigation, click Account > Download CLI. Click the applicable operating system to download the CLI installer.

Step 2: Run the CLI installer

Run the installer application depending on your operating system. See Operating System Support for more information.

Step 3: Log in to the Domino CLI

  1. In a command prompt, type domino login https://<your-domino-url>.

    The CLI opens your default browser to the Domino sign-in page.

    Note
    		 After downloading and installing the Domino CLI, you have to close out of the terminal fully for it to recognize the install.

  2. Sign in from the browser tab that opens. You might be required to log in.

    If a browser doesn’t open automatically, or Desktop isn’t supported on your machine, the terminal prints a URL. Open it in a browser on the same machine you’re running the CLI from, since sign-in redirects back to a local address on that machine.

  3. Once you’ve signed in, the browser tab shows a message that authentication succeeded and you can close the tab. The CLI receives the authorization automatically.

Note
 CLI versions older than 6.2.3 use a different authentication client and can no longer log in. If domino login fails after upgrading Domino, download and reinstall the latest Domino CLI.

Install the Domino CLI on a headless Linux machine

A headless installation is an installation of the Domino CLI on a server or machine that does not have a GUI. This is commonly done for machines that are used to automate tasks or run Domino CLI tasks in a server environment or on a Domino Workspace.

Install CLI from the command line

Step 1: Install headless Java
apt install openjdk-8-jre-headless
Step 2: Download the CLI installer

Replace <domino-url> in the link below with the Domino URL that is currently linked to the client.

wget https://<domino-url>/download/client/unix -O /tmp/domino-install-unix.sh
Step 3: Run the CLI installer
sh /tmp/domino-install-unix.sh
Note
 If you encounter an AtkWrapper error, resolve it by commenting out /etc/java-8-openjdk/accessibility.properties assistive_technologies and re-running the installer. 
sed -i 's/^assistive_technologies=/#assistive_technologies=/g' /etc/java-8-openjdk/accessibility.properties
Step 4: Log in to the Domino CLI

Run domino login https://<your-domino-url> as described in Step 3: Log in to the Domino CLI above.

Note
 domino login opens a browser and completes sign in through a local callback on the same machine, so it requires a browser on the machine running the CLI. On a headless machine with no browser installed, open the URL that the CLI prints in a terminal instead, for example, over an SSH session with X11 forwarding or a browser installed directly on that machine. A browser on a different machine (such as your laptop) can’t complete the callback.

Use the CLI

Check out the Domino CLI Reference for documentation about using the CLI.

Operating system support

Domino supports recent versions of the following operating systems:

  • Ubuntu Linux

  • Windows 10

  • macOS

Linux

The Domino CLI can be installed on Linux machines using either the GUI or headless method.

If you chose to install the CLI using the GUI:

  1. Navigate to the directory where you downloaded the CLI installer.

  2. Run the installer:

    sh domino-install-unix.sh

Windows

Domino recommends that you use the version of the Domino CLI that comes bundled with a 64-bit JRE. The 32-bit version is deprecated.

macOS

You must have root privileges to run the Domino CLI for macOS.

On Mac OS X, the installer prompts you to enter administrator credentials. If you do not have administrator privileges, you can click Cancel. When the installer prompts you to manually update your PATH, click Ignore to continue the installation process, then add export PATH="$PATH:/Applications/domino" (assuming the default installation folder) to your bash_profile.

Having trouble? Email us.