Altium Designer Documentation


Created: July 7, 2022 | Updated: July 7, 2022

Parent page: VersionControl Commands

The following pre-packaged resource, derived from this base command, is available:

Applied Parameters: None


This command is used to check out and open a design project that is under version control, i.e. one that resides in a Design Repository.


This command is available from any editor by choosing the File » Check Out command from the main menus.


After launching the command, the Check Out dialog will open. Use the dialog's Check out from field to choose the required repository from a drop-down listing of all connected and activated design repositories available to you.

Click  to open the Data Management - Design Repositories page of the Preferences dialog if you need to connect to a different repository.

The folder hierarchy within the chosen design repository is presented to you in the Folders region of the dialog. Use this region to specify the exact folder that is to be checked out from the repository.

Use the Check out to field to specify to where the nominated folder content is to be checked out. This is your local sandbox area, for example.

After clicking OK, the selected repository project folder and its constituent files will be checked out to the nominated local folder and opened.


  1. The local folder is the folder defined as a checkout folder for the selected repository and the checked out project is subsequently linked to its counterpart in the VCS repository. The VCS link instructs the version control system to monitor and detect any differences between the files in local checkout folder and their equivalents in the VCS repository folder.
  2. Design repositories available to you can include local/network SVN repositories, as well as repositories made available through a managed content server to which you are currently signed in.
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: