Synchronization

Synchronization lets you manage and share your JetClient project using Markdown files. Each project element (requests, folders, scripts) is stored in a separate file, making it easy to track changes and collaborate using any version control system like Git.

How It Works

JetClient syncs your workspace to Markdown files that serve as containers for blocks:

• Metadata: TOML format for request, folder, and script metadata
• Variables: JSON5 format for variable definitions
• Scripts: JavaScript code
• Documentation: Markdown content

You can use any version control system (like Git) to track these files and collaborate with your team.

Configuration

Project Settings

Configure synchronization when creating a project or in project settings:

• Enable Sync: Save project data to files
• Auto-Sync: Automatically sync changes between JetClient and files
• Sync Directory: Specify a unique directory for sync files

Folder Settings

Configure synchronization when creating a folder or in folder settings:

• Enable/disable sync for specific folders
• Affects all nested items (requests, subfolders)

Sync Modes

Auto-Sync

When enabled:

• Changes are automatically saved to files
• External file changes are applied automatically

Manual Sync

When disabled:

• Save/restore changes manually via the context menu
• Project tree shows sync status:
  • Green: New items (no sync file)
  • Blue: Modified items (unsaved changes)
  • Red: Missing items (sync file exists but the item is deleted)

Managing Changes

Access sync actions via the context menu:

• Save/Save All: Write changes to files
• Restore/Restore All: Load changes from files
• Show Diff: Compare and resolve differences
• Open Sync File: View the raw sync file

Example

Explore sync files in the JetClient Demo Repository.
Example script: Create Owners