CLI: How to download project files into your local machine via the Domino CLI

Version/Environment (if relevant):

This applies to all versions of Domino.

Issue:

You can use the Files page to download individual files from a project. However, if you have a large number of project files, you can use the Domino Command Line Interface (CLI).

Steps:

Part 1: Install and log into the Domino CLI

1. Install the Domino CLI using these steps: Your username > Download CLI > Run the installer application according to your Operating System (macOS, Windows, Linux).

2. In the terminal, run the domino login command to log into your Domino deployment. 

domino login https://your-domino-url.com

Then enter your username and password.

You'll see output similar to this: 

You need to authorize using CLI with Domino.
Please go to https://your-domino-url.com/authorizeCli to get your authorization code.
Please note that you may be required to login. 
Enter the resulting authorization code below.
Authorization code: 

3. Copy the URL from the output and paste it into a new tab in your browser. Then copy the authorization code. 

4. In the terminal, paste in the authorization code. You'll see Login succeeded.

Part 2: Download the project files to your local machine

5. Run the domino get command to create a folder on your local machine containing your project.

domino get your-project-name

You'll see output similar to this:

Project get complete. Make sure to navigate to your new project folder by running:
    cd your-project-name
To run a file on Domino, type:
    domino run [command-to-run]

6. On your local machine, search for your-project-name and confirm that the folder was created. 

7. Run the cd command to change directories and navigate to your new project folder:

cd your-project-name

8. If it's been a while since you last ran domino get and you need to refresh and download the latest copy of your files into your current project folder, run the domino download command: 

domino download

9. On your local machine, confirm that your-project-name folder has the latest files.

Note: If you've made changes that conflict with changes in the cloud, you'll see both versions of the conflicting file side-by-side. There are two reasons files in the cloud might change: first, your collaborators on a project might have made changes; second, you might have executed a run that produced new output files.

Notes/Information:

• Install the Domino Command Line Interface (CLI)
• Download Files with the CLI
• Get a project from the server onto your computer for the first time
• Download the latest version of your files