Legacy: Using Domino with Git

If you are using version 1.47 or later, Domino now supports native integration with Git. This article is no longer relevant and the method described below is deprecated. Please follow these instructions for using Domino with Git


This article describes best practices for using Domino and Git simultaneously. If you're looking to use PIP to install packages hosted on Github, please see this page.

Setting Up Your Git Repo as a Domino Project

There are a few things that will make it much easier to have a Git repo and a Domino project coexist.

Starting in the root of your Git repository, you can initialize a Domino project based on the files that are there:

domino init

After the project has been initialized, do an initial upload to Domino’s server by running:

domino sync

You must also configure Git to ignore any big data files that will be tracked by Domino. To do this, modify (or add) a .gitignore file:

# ignore any big files

For a more complete primer on .gitignore files, please read this article.

Finally, you should also add the file .domino/config.json to be tracked by Git:

git add .domino/config.json
git commit -m "Adding Domino project link file"

This file will tell the Domino CLI what project is attached to this Git repo and will make it easier to clone the repo/project to another machine.

Getting the Domino project onto a New Machine

To get the combined repo/project onto a new machine, you should first clone the Git repository:

git clone http://path/to/origin

Move into the newly created Git repo folder. To restore all the Domino-related files, run:

domino restore

If you’ve added the Domino project link as described above, then the restore command should automatically know which project to attach to. Otherwise, you’ll need to specify the name manually.

Was this article helpful?
0 out of 0 found this helpful