Skip to main content

​
Why Git for Collaboration?

Auk uses Git as its collaboration mechanism instead of cloud services, giving you complete control over your data and collaboration workflow.

Full Control

Choose any Git service - GitHub, GitLab, Gitee, or self-hosted

Version History

Complete change history with the ability to rollback to any point

Standard Workflows

Use familiar Git workflows - branches, pull requests, code review

Offline First

Work offline, commit locally, sync when ready

​
How It Works

​
Sync Flow

  1. Local Changes - You modify collections or environments
  2. Auto Commit - Auk automatically commits changes to local Git
  3. Sync - Changes are pushed to remote repository
  4. Pull Updates - Team members’ changes are pulled automatically
  5. Conflict Detection - Conflicts are detected and resolved

​
Supported Git Services

​
GitHub

  • Public and private repositories
  • OAuth authentication (coming soon)
  • SSH and HTTPS support
  • Organization repositories
# Example repository URL
[email protected]:username/api-collections.git

​
Authentication Methods

Most secure and convenient method: 
# Generate SSH key
ssh-keygen -t ed25519 -C "[email protected]"

# Copy public key
cat ~/.ssh/id_ed25519.pub

# Add to Git service (GitHub/GitLab/etc.)

​
HTTPS with Token

Use personal access tokens: 
# GitHub Personal Access Token
# Settings → Developer settings → Personal access tokens

# Clone with token
git clone https://[email protected]/username/repo.git

​
OAuth (Coming Soon)

One-click authentication with GitHub and GitLab.

​
Sync Strategies

​
Automatic Sync

Auk can automatically sync at regular intervals:
  • Every 5 minutes - For active collaboration
  • Every 15 minutes - Balanced approach (default)
  • Every hour - For less frequent updates
  • Manual only - Full control over when to sync

​
Manual Sync

Trigger sync manually when needed:
  • Before starting work (pull latest changes)
  • After completing a feature (push your changes)
  • Before switching workspaces
  • When resolving conflicts

​
Conflict Resolution

When multiple team members edit the same collection:
1

Conflict Detection

Auk detects conflicts during sync and pauses the operation
2

Review Changes

View side-by-side comparison of conflicting changes
3

Choose Strategy

  • Keep local changes
  • Use remote changes
  • Smart merge (combine both)
  • Manual resolution
4

Complete Sync

After resolution, sync completes automatically

​
Branch Management

Use Git branches for different workflows:

​
Feature Branches

# Create feature branch
main → feature/new-endpoints

# Work on feature
# Merge back when ready

​
Environment Branches

# Separate branches for environments
├── main (production)
├── staging
└── development

​
Team Branches

# Personal branches for each team member
├── main
├── alice/work
└── bob/work

​
Best Practices

Auk generates descriptive commit messages automatically:
Add new authentication endpoints

- Added POST /auth/login
- Added POST /auth/refresh
- Updated environment variables

Co-Authored-By: Auk <[email protected]>
  • Active collaboration: Sync every 5-15 minutes
  • Solo work: Sync hourly or manually
  • Before meetings: Always sync to get latest changes
Keep one repository per workspace for clean organization:
team-apis/              # One repository
├── collections/
├── environments/
└── README.md
Never commit sensitive data:
  • Use environment variables for secrets
  • Add .env files to .gitignore
  • Use Git secret scanning tools

​
Advantages Over Cloud Sync

FeatureCloud SyncGit Sync
Data ControlService providerYou
PrivacyShared infrastructureYour infrastructure
Version HistoryLimitedComplete Git history
BranchingNot availableFull Git branching
Offline WorkLimitedFull support
CostSubscription feesFree (or your Git hosting)
Vendor Lock-inYesNo

​
Next Steps

Setup Git Sync

Configure your first Git repository

Authentication

Set up SSH keys or access tokens

Auto Sync

Configure automatic synchronization

Conflict Resolution

Learn how to handle merge conflicts