Domino Quick Start

This guide assumes you're comfortable doing basic command-line operations (Terminal on a Mac, or CMD on Windows). If you want to brush up, here's a quick guide for Mac or Windows.

1. If you don't already have one, create a Domino account

The first time you run any domino command, Domino will ask you to login using the account you created here.


2. Download and install the client software


3. Create a project

Go to your terminal (or CMD, on Windows) and navigate to your Desktop.
Type domino create tutorial. You should see something similar to the following:

~$ cd Desktop
Desktop$ domino create tutorial
Creating project with name tutorial
Created project nick/tutorial successfully.
    Downloading ".dominoignore" @ 861d4bcb60057ebdc31d9fe53b7674c4c9aad22f...
      complete!
Project creation complete. Make sure to navigate to your new project folder by running:
    cd tutorial
Then to run a file on Domino, type:
    domino run [command-to-run]
This will create a "tutorial" folder on your desktop and a "tutorial" project on your Domino overview screen.

4. Add some code

Domino supports R, Matlab, Python, and shell scripts. Download one of the sample files below and put it in your project folder.

In a real project, you can have as many files as you want, and name them whatever you want. Domino will use the file extension (e.g., ".r" or ".py") to determine the file type.


5. Run your code in the cloud

In the terminal,
  • navigate to your project folder: cd tutorial
  • and type: domino run file, where file is the file you want to execute (e.g., "main.py", "main.r", "main.m")

The "run" command will upload all your changed files and execute the file you specified. You should see something like this:

tutorial$ domino run main.py
  Determining which files are out of date...
      - Comparing contents of main.py......completed.
Changes to upload to the server:
--------------------------------
  + Adding file main.py
Starting upload of new files:
-----------------------------
  Uploading "main.py" @ d9416cda5d58c286677e655e282d79549b6e4c21...
      complete!
Run for project nick/tutorial started with ID 524fc4fde4b06a09ecd56bb9. You can view progress of your run
here: https://app.dominoup.com/nick/tutorial/run/524fc4fde4b06a09ecd56b

Browse to the link that was printed out: here you can watch the progress of your run.

When the run finishes, go back to the terminal and run domino download
This command will download the most recent files from the cloud, including the new image file that your script generated.

Notice

1. If your run generates new files, you will need to run domino download after your run to get those files on your computer.

2. The sample code creates an image file in the "results" folder. The generated image will show up in the Results tab on your project screen, and will be included in notification emails.


6. Change your code and re-run

Edit your code file: instead of printing out "hello", make it print out something else. Now re-run your code:
domino run file

Notice

1. When your run finishes, you should receive an email with any console output from the run, along with any files that your run created or modified (these are the Results of the run).

2. On the Runs tab of your project page, you should now see two run entries.


7. Browse your past work

You can browse your files on Files tab of your project page. Below the list of files, you can see all "revisions" of your project. Each revision corresponds to a run of your code. Clicking on a particular revision will let you browse your files as of that past point in time.

To confirm this is working, browse to a past revision of your main code file to see what it looked like before you changed it in the previous step.


If this article is incorrect, confusing, out of date, or unhelpful, please don't hesitate to contact us. We'll do our best to help you.