CADBase Integration with FreeCAD

Version control, cloud storage and team collaboration.

FreeCAD and CADBase integration

Table of Contents

CADBase Library

CADBase Library is a bridge between FreeCAD and the CADBase platform, adding cloud design advantages to local design:

  1. Accessibility — work with projects from any device.
  2. Project Storage — synchronize FreeCAD with cloud storage.
  3. Team Collaboration — parallel development of components and modifications.
  4. Security — reliable storage and efficient version control.
  5. Component Library — use ready-made parts with models for FreeCAD.

Save projects through CADBase Library for FreeCAD and access components from any computer.

File Sets on CADBase Platform

File Sets Concept

File sets organize data by applications within component modifications. For example, a designer works with the FreeCAD set, while documentation is attached directly to the modification.

There are no restrictions on data storage in sets — you can upload any files.

Set Specialization

  • FreeCAD — drawings, models, and resources for FreeCAD design.
  • Other sets — files from various CAD and software applications.

How the Addon Works

The addon creates a folder hierarchy for components and synchronizes only FreeCAD set files. This allows teams to work in parallel across different applications without version conflicts.

Installation and Setup

Installation via FreeCAD Addon Manager

This is the simplest way to install CADBase Library:

  1. In FreeCAD main menu, select Tools → open Addon Manager.
  2. Wait for the list of available addons to update.
  3. Type "CADBase Library" in the search bar and select the found workbench.
  4. Click the Install button and wait for the process to complete.
  5. Restart FreeCAD.
  6. After restart, CADBase Library will appear in the workbench list.
Important requirement:

CADBase Library requires FreeCAD version 0.21 or higher.

Configuration

First Launch and Setup

After restarting FreeCAD:

  1. Select the CADBase Library workbench.
  2. Specify the folder for local library.
    Your components from CADBase will be available in this folder.
Selecting CADBase Library Workbench

Workbench Configuration

To open the CADBase Library Configuration window:

  1. In the CADBase Library window, go to the Options tab.
  2. Click the Settings button.
Library Path

Specify the folder on your computer where the local component library will be stored.

Important:

Changes will take effect after restarting FreeCAD. When changing the path, existing files are not automatically moved.

Server Address

Specify the URL or IP address of the CADBase server for connection.

To reset the setting to default, simply click Set official.

CADBase Library Addon Settings in FreeCAD
Upload Parameters

Configure cloud storage logic:

Skip calculate hash
Uploads only new files without checking changes in existing ones

Forcibly update files
Updates all files in the cloud, ignoring checks

Note:

These settings only affect data upload to the cloud. When downloading, files are never automatically overwritten.

Authorization on CADBase Platform

To work with cloud storage, you need to obtain an access token:

  1. Click the Authorization button in the CADBase Library window.
  2. In the opened window enter:
    • Username (your login)
    • Password
  3. For new users: check Set to create a new user...
  4. Click the OK button to get the token.
  5. Wait for authorization to complete.
CADBase Library Credentials in FreeCAD

Authorization data will be saved — you won't need to enter the password on subsequent FreeCAD launches.

Token refresh: repeat steps 1 and 4.

Verification

Ensure the library is correctly connected to your account:

  1. Switch to the CADBase Library workbench.
  2. Click Update list.

    Update list button in CADBase Library interface for updating component list
  3. Wait for your bookmarked components to appear in the library tree.

Note: After clicking the button, wait for the process to complete... Time depends on data volume and internet speed. Do not close FreeCAD or interrupt the process, otherwise data won't download completely.

Done! If you see the component list — setup was successful. You can proceed to work with the library.

Practical Applications

Creating New Component

A component can be a part, assembly, node, or any other design development object.

Creating a component in CADBase library through FreeCAD — 3 steps:

  1. Click the New component button.
  2. Enter the component name in the dialog window.

    Dialog window for adding New component with name input field
  3. Click OK to create.

Component creation process

After creation:

  • Component will appear in your bookmarks.
  • Initial modification N1 will be created.
  • Component list in library will update.

Creating Component Structure

To start working with a component, create structure in local storage:

  1. Find the created component in the library tree
  2. Double-click on it
    System will create folders for modifications and file sets.

Saving Document to File Set

Link document with component for further synchronization:

  1. Open or create a FreeCAD document.
  2. Save it to the file set folder:
    CADBase LibraryComponentN1📁FreeCAD
Note:

Files from this folder will be uploaded to the cloud when sending changes.

Location of FreeCAD file set folder

FreeCAD folder location

Data Upload

To send changes to the cloud:

  1. Select modification with changed files.
    You can select modification folder or specifically FreeCAD file set folder.
  2. Click the Upload files button.
  3. Review changes in the opened window:
    Dialog for sending data to CADBase remote storage: commit message and changes list

    File upload window (example)

    new — file will be added to cloud
    modified — file will replace old version in cloud
    deleted — file will be deleted from cloud
  4. Add change comment (optional).
    Will help colleagues understand what was changed.
  5. Click OK to start upload.
    Change upload will start after clicking the button.

Upload progress can be tracked in FreeCAD's Report View panel.

Local File Replacement

If you need to download fresh file version from cloud:

  1. Find the file in library tree and click Open directory
  2. Delete the file in the opened folder.
  3. Return to FreeCAD and double-click on the file set folder.
    System will download current version from cloud.
When is this needed?

If file was modified in cloud by another user or you want to revert your changes.

Button for opening file folder

File Import to Document

Add ready-made parts and assemblies to your project:

  1. Find the file in component library.
  2. Click Merge or double-click the file.
  3. Model will appear in your document
    As separate object for editing.

Useful for: assemblies, using standard parts, working on complex projects in parts.

Importing model into current FreeCAD document

Bookmarks Management

Bookmarks help quickly find needed components. Manage them on CADBase platform:

  1. Find the component via search on CADBase.
  2. Open the component page.
  3. Click the bookmark icon on the component page
    Adds or removes from bookmarks.
Note:

New bookmarks will appear after refreshing the list.
Already downloaded components will remain in library even if removed from bookmarks.

Bookmarks management on platform

Component Access Configuration

New components are private by default. To open access:

  1. Click Copy link on component.
  2. Open the link in browser.
  3. In component settings change access to "public".
  4. Save the change.

Now the component is visible to other users.

Component access configuration on CADBase platform — access type selection

Access type selection on CADBase platform

Frequently Asked Questions (FAQ)

Can I work offline?

Yes, with previously downloaded components.

What happens with version conflicts?

Priority is given to local version.

Can I use one account on multiple computers?

Yes, without restrictions.

Can I use special characters in names?

You can use any characters, but note that component names will become folder names in file system.

Which files can be imported into document?

Supported formats: FCStd, STEP, BRP and BREP.

How is data security ensured?

Flexible access management system allows configuring data access rights for individual users and companies.

Can the workbench work in Intranet (isolated network)?

Yes, this requires deploying the server part inside the network.

Troubleshooting

Authorization error

Refresh token via Authorization button.

No connection

Check internet connection and access to address specified in Server URL.

Components not displayed

Ensure they are added to favorites on the website.

Settings not applied

Some settings require FreeCAD restart.

Files not updating in cloud (SHA256 errors)

Enable Forcibly update files in settings.

Files not synchronizing (outdated UUID)

Delete component files from component folder and modification from file set.

Debugging

Create cadbase_file_2018.log file in library root, it will save logs and other data for debugging.

Enhance FreeCAD with built-in version control and secure team collaboration.


  • CADBase Library for FreeCAD is developed and maintained by the CADBase team.
  • Maximum file size - 5 GB, each user gets 15 GB of storage.
  • Access is provided free of charge, without hidden fees or restrictions.