More information about .local folder from Uipath Project

Hi Everyone,

When we create any new UiPath Path project there is .local folder created that usually stay in hidden mode.

I’m looking for information about following file that is from .local folder only.

  1. From .local>db there is reference file what info it contains.
    image

  2. From .local>install
    image

  3. From .local
    image

Thanks

To answer your specific questions:

  1. As far as I can see, references.db contains references used by Studio for a good user experiences, e.g. hashes of files so that changes can be detected faster. If you delete it, then Studio should regenerate it upon opening the project. It’s a LiteDB, so you can look at it yourself e.g. with GitHub - mbdavid/LiteDB: LiteDB - A .NET NoSQL Document Store in a single data file.
    image

  2. CodedWorkflow.cs is the base class for coded workflows or coded test files. As an example, when you create a new coded test case, that file extends CodedWorkflow. CodedWorkflow is auto-generated when your project uses either. It is in a different folder for me though - it’s in .local\.codedworkflows for me. So that might have changed in recent Studio versions (I’m using 24.10).
    image

  3. ProjectSettings.json keeps some local Studio settings, e.g. related to break points and visual state of the UI.

Generally speaking, contents of that folder are automatically generated by Studio and should not be edited manually under normal circumstances. There is some general information on this page in the documentation:

.local - Contains data cached locally for the project.

  • The .local folder is hidden. You can enable viewing hidden items from the Windows File Explorer settings.
  • The .local folder should not be shared across projects.

Is there anything in particular you need to achieve? If you’re trying to figure out if you need to check the .local folder into source control, you don’t. Cf. here:

We recommend adding all the files and subfolders in the project folder to source control (the .local subfolder is ignored by default).

2 Likes

@Chris_Krah thanks for information. I just want little confirmation around .local folder, you said content of .local folder is automatically generated. That contain cached data for the project.

So my question is - We shouldn’t push .local folder in source control.

Thanks

Correct, you shouldn’t push the .local folder into source control. Also check the last sentence of my previous post.