Local Directory/Git Sync

To better enable collaboration between team members, Yaak allows syncing workspace data to the local filesystem. This can be configured when creating a new workspace:

Sync can also be configured from Workspace Settings:

When enabled, Yaak monitors both the workspace and destination directory, performing a sync operation whenever changes are detected.

• Changes originating from the workspace are synced silently

• Changes originating from the directory show a summary and confirmation prompt

In order to work best with Git, YAML is used as the destination format. In summary, the directory contents are as follows:

• One file per resource (Workspace, Request, etc)

• Stored as files named yaak.${MODEL_ID}.yaml

## Enabling Git for a Workspace

If the workspace data directory has not been initialized as a Git repository, this can be done through the sync dropdown (or manually from the command line by running git init).

Once a Git repository is detected, you will be presented with various Git actions.

From here, you can create branches or commit changes like you would any other visual Git client.

## Opening Existing Directory

Configuring a workspace for sync requires selecting an empty directory. To “import” an existing sync directory (eg. from a Git repo) use the “Open Workspace” menu item from the workspace menu instead. This will perform the initial import and set the sync directory on the workspace accordingly.

Syncing Environments

Since environment variables usually contain sensitive values, they are not included in directory sync by default.

To include an environment in directory sync, make it “sharable” within the right-click context menu.

##