Unify and manage your data

Connect Reltio IDE to a Git repository

Learn how to connect Reltio IDE to the Git repository that holds your business configuration, and open your configuration files in the editor.

Prerequisites

Before you connect a Git repository, make sure you have the following requirements:

  • Reltio IDE installed in Cursor or VS Code.

  • Git installed on your machine and available on your system path. Download Git from git-scm.com/downloads.

  • The URL of the Git repository that holds your business configuration. Read access to the repository. You also need write access if you need to commit and push changes.

  • An empty folder open in your editor. Reltio IDE clones your business configuration repository into that folder. If the repository is already cloned on your machine, open the folder that contains the clone instead.

To connect a Git repository
  1. In the activity bar, select the Reltio icon to open the RELTIO IDE view.
  2. Select Connect your Repository.
  3. Enter the Git remote URL to clone, for example https://github.com/org/repo.git, and press Enter.
    Figure 1. Enter a Git remote URL

    If the folder already contains a Git clone, Reltio IDE detects the repository and skips this step.

  4. Complete any sign-in that Git requests. The prompts depend on the Git provider and authentication method. While the repository is being cloned, Reltio IDE displays a Cloning repository... notification.

    A public repository does not require additional sign-in. For a private repository, Git displays Select an account:

    • Select an account that has access to the repository, and then select Continue.

    • If none of the listed accounts has access to the repository, select Add a new account and sign in through your browser. The clone continues after you sign in.

    Figure 2. Select an account during a clone
    If Reltio IDE displays an error instead of cloning the repository, refer to the Troubleshooting steps for the message displayed.
  5. Verify that the repository and its configurations appear in the RELTIO IDE view.

    Reltio IDE automatically searches up to 10 folder levels in the repository for files named BusinessConfig.json. The file-name search is not case-sensitive. If the repository does not contain a BusinessConfig.json file, Reltio IDE displays the message No BusinessConfig.json found. Locate the L3 configuration file and opens a file picker. Select the configuration file you want to open.

    Figure 3. Connected repository in RELTIO IDE

    The RELTIO IDE view reflects the repository folder structure and automatically discovers files named BusinessConfig.json. To add a configuration file with a different name, such as L3.json, right-click the .json file in Explorer and select Add Config. The file must contain a valid Reltio business configuration.

To open and manage your configuration
  1. In the RELTIO IDE view, select a configuration.
  2. Select the Open L3 icon beside the configuration to open it in the editor.
  3. Expand the configuration to browse its entity types, relation types, attribute types, and other object types.
  4. Use the context menu on the configuration and on the object type folders in the tree view to perform modeling actions, such as:
    • Adding a new entity type or relationship type

    • Adding a new attribute

    • Viewing the ontology

    These actions work the same way as they do for a tenant. To view the ontology, right-click the Entity Types or Relation Types folder and select Show in Ontology.

  5. To remove a configuration from the RELTIO IDE view, right-click the configuration and select Remove Configuration. This removes the configuration from the tree but does not delete the file from the Git repository. To disconnect the Git repository from the current workspace, right-click the repository and select Remove Repository. Reltio IDE removes the repository connection and deletes the cloned repository contents from the workspace folder.

Result

Reltio IDE connects to the Git repository and displays the discovered business configuration files in the RELTIO IDE view. You can open a configuration, browse its objects, perform supported modeling actions, add configuration files that are not named BusinessConfig.json, and remove configurations or disconnect the repository when needed.

Reltio IDE uses Git to clone or detect the repository and open the business configuration files hosted in it. After that, your edits are saved as regular file changes. Use the built-in Source Control view in VS Code or Cursor to review diffs, stage changes, commit, and push them to the repository.

Troubleshooting

If Reltio IDE cannot clone the repository, use the following troubleshooting steps:

  • Repository not found: The selected account might not have access to the repository, or the repository URL might be incorrect. Verify the URL, select another account, or select Add a new account.

  • Git executable not found: Install Git from git-scm.com/downloads and ensure that Git is available on your system path. Close and reopen the editor, and then run git --version in the terminal. After the command displays the installed Git version, select Connect your Repository again.