About Domino
Domino Data LabKnowledge BaseData Science BlogTraining

Install the Domino Command Line Interface (CLI)

  1. Click your username at the bottom of the main menu to download the CLI installer depending on the operating system.

    download cli

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

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

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

    The system prompts you to authorize using the CLI with Domino.

  4. Paste the following URL in your browser to use authorizeCLI to get the authentication code.

    https://<your-domino-url>/authorizeCli
    Note
    		 You might be required to login.

  5. Enter the authorization code provided and press Enter. A message indicates that the login succeeded.

Congrats, you’re all set! 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

You must run the Domino CLI in a GUI-based Linux environment. The CLI doesn’t work on headless Linux machines.

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. If you didn’t enter administrator credentials during the installer process, you can add export PATH="$PATH:/Applications/domino" (assuming the default installation folder) to bash_profile.

Having trouble? Email us.