Skip to content

The .devspace folder

Gabriel Gatu edited this page May 8, 2020 · 1 revision

What is

When importing a project DevSpace creates a special folder inside your project's root, called .devspace (note the initial dot, this means the folder is hidden when opening the project folder with a file manager). For every imported project, a .devspace folder is created.

What's inside .devspace

This special folder contains everything you're going to generate while using your project inside DevSpace: configuration files, issues, notes, links and so on.

Furthermore, every file in this folder is a regular .json file correctly indented: opening and editing this files in your editor is very easy and totally accepted, just remember to respect the semantic rules, otherwise DevSpace will not be able to parse them.

Benefits

By creating the .devspace folder in every project we get numerous features for free that would otherwise be very hard to obtain.

The most important of all is for sure ease of backup: if you're using git you can just track this folder and it will be pushed among all your other changes to your remote.

A secondary cool feature is ease of sharing: if you work on the same project with a team of people, you can use DevSpace to organize and track everything and then just push&pull from git to synchronize between team members.

Finally, this project structure gives the ability to quickly edit manually any DevSpace's file in your editor while you're working on your project, and, if you want to remove it from your project, just delete the folder and you're done.

How to remove it

Since DevSpace just creates a .devspace folder in your project root, if you want to remove it you can manually delete this folder and you're done.

Alternatively you can use DevSpace: just click on the remove button while your project is selected (located at the bottom left of the screen) and select 'Hard remove': this way the .devspace folder will be deleted as well.

Clone this wiki locally