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
-
In a command prompt, type
domino login https://<your-domino-url>. The CLI opens your default browser to the Domino sign-in page.After downloading and installing the Domino CLI, you have to close out of the terminal fully for it to recognize the install. -
Sign in from the browser tab that opens. You might be required to log in.
If a browser doesn’t open automatically, or
Desktopisn’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. On a machine with no usable local browser (for example, a remote server accessed over SSH), rundomino login --device https://<your-domino-url>instead to use the device code sign-in flow, which prints a verification URL and short user code you can open on any other device. -
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.
CLI versions older than 6.2.3 use a different authentication client and can no longer log in. If
domino loginfails after upgrading Domino, download and reinstall the latest Domino CLI.
Sign in from a machine without a local browser
When the CLI can’t open or receive a redirect from a local browser, it uses the OAuth 2.0 Device Authorization Grant flow (RFC 8628) so you can complete sign-in from a browser on any other device, such as your laptop or phone. Use this flow when:- You’re running the CLI over SSH on a remote server or Domino Workspace with no browser installed.
- Your machine is headless and the
Desktopintegration isn’t available. - Sign-in redirects to a local callback URL that a browser on a different machine can’t reach.
-
Run
domino login --device https://<your-domino-url>on the machine you want to authenticate. The CLI prints a verification URL and a short user code, for example:The CLI then polls Domino for the token in the background. - On any device with a browser, open the verification URL, enter the user code, and sign in to Domino.
-
On the consent screen, review the requested access and select Grant Access.
Once you approve, the CLI receives the token automatically and prints
Login succeeded. You can then run any otherdominocommand on that machine.
domino login --device again to get a new code.
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<domino-url> in the link below with the Domino URL that is currently linked to the client.
If you encounter an
AtkWrapper error, resolve it by commenting out /etc/java-8-openjdk/accessibility.properties assistive_technologies and re-running the installer.domino login \https://<your-domino-url> as described in Step 3: Log in to the Domino CLI above.
On a headless machine with no browser installed, run
domino login --device https://<your-domino-url> to use the device code sign-in flow instead of a local callback. The CLI prints a verification URL and short user code, which you can open in a browser on any other device (for example, your laptop) to complete sign-in.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:- Navigate to the directory where you downloaded the CLI installer.
-
Run the installer:
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 yourPATH, 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.