Setup Git Sync

​

Why Use Git Sync?

​

How It Works

Local Workspace ←→ Git Repository ←→ Team Members
    ↓
Auto-commit local changes
    ↓
Periodic sync (Pull + Push)
    ↓
Conflict detection & resolution

​

Supported Git Services

• GitHub - Public/private repositories
• GitLab - Self-hosted or GitLab.com
• Gitee - Chinese Git service
• Bitbucket - Atlassian Git service
• Self-hosted Git - Any standard Git server

​

Prerequisites

1. Git installed on your system
2. Git repository created on your chosen service
3. Authentication configured (SSH keys or access token)

​

Check Git Installation

# Check if Git is installed
git --version

# If not installed, install Git:
# macOS: brew install git
# Windows: Download from git-scm.com
# Linux: sudo apt install git

​

Authentication Methods

​

SSH Keys (Recommended)

# Generate new SSH key
ssh-keygen -t ed25519 -C "[email protected]"

# Press Enter to accept default location
# Enter passphrase (optional but recommended)

# Start SSH agent
eval "$(ssh-agent -s)"

# Add SSH key
ssh-add ~/.ssh/id_ed25519

# macOS
pbcopy < ~/.ssh/id_ed25519.pub

# Linux
cat ~/.ssh/id_ed25519.pub | xclip -selection clipboard

# Windows (Git Bash)
cat ~/.ssh/id_ed25519.pub | clip

# GitHub
ssh -T [email protected]

# GitLab
ssh -T [email protected]

# Should see: "Hi username! You've successfully authenticated"

​

HTTPS with Personal Access Token

​

Create Git Repository

# Using GitHub CLI
gh repo create my-api-collections --private

# Or via web interface:
# 1. Go to github.com
# 2. Click "+" → "New repository"
# 3. Enter repository name
# 4. Choose "Private"
# 5. Click "Create repository"

# Using GitLab CLI
glab repo create my-api-collections --private

# Or via web interface:
# 1. Go to gitlab.com
# 2. Click "New project"
# 3. Enter project name
# 4. Choose "Private"
# 5. Click "Create project"

# Create local repository
mkdir my-api-collections
cd my-api-collections
git init

# Create README
echo "# My API Collections" > README.md
git add README.md
git commit -m "Initial commit"

# Add remote (replace with your URL)
git remote add origin [email protected]:username/my-api-collections.git

# Push to remote
git push -u origin main

​

Configure Git in Auk

# SSH (recommended)
[email protected]:username/my-api-collections.git

# HTTPS
https://github.com/username/my-api-collections.git

main

​

Verify Git Sync

1. Check Sync Status
   • Look for Git icon in workspace selector
   • Should show “Synced” or last sync time
2. Make a Change
   • Create a new collection or request
   • Wait for auto sync or click “Sync Now”
3. Check Repository
   • Visit your Git repository on the web
   • You should see your collections in collections/ folder
4. Test from Another Device
   • Install Auk on another device
   • Create workspace with same Git repository
   • Your collections should appear

​

Git Workflow

​

Daily Workflow

1. Start Auk → Auto pull latest changes
2. Make changes → Auto-commit locally
3. Auto sync → Push to remote
4. Team members pull → See your changes

​

Manual Sync

1. Disable auto sync in settings
2. Make your changes
3. Click “Sync Now” when ready
4. Review changes before pushing

​

Branch Workflow

1. Create a new branch in workspace settings
2. Make your changes
3. Push branch to remote
4. Create pull request on Git service
5. After merge, switch back to main branch

​

Troubleshooting

​

Authentication Failed

# Test SSH connection
ssh -T [email protected]

# If fails, check SSH agent
ssh-add -l

# Re-add key if needed
ssh-add ~/.ssh/id_ed25519

• Verify token has correct permissions
• Check token hasn’t expired
• Try regenerating token

​

Push Rejected

# Pull latest changes first
# Auk will do this automatically, or click "Pull"

# If conflicts, resolve them
# Then push again

​

Merge Conflicts

1. Auk will show conflict resolution dialog
2. Choose resolution strategy:
   • Keep local changes
   • Use remote changes
   • Manual merge
3. After resolving, sync again

​

Large Files

• Git has file size limits (usually 100MB)
• Don’t commit large files (videos, images, etc.)
• Use .gitignore to exclude them
• Consider Git LFS for large files

​

Slow Sync

• Check network connection
• Reduce auto sync frequency
• Use shallow clone for large repositories
• Consider splitting into multiple workspaces

​

Best Practices

​

Repository Organization

my-api-collections/
├── collections/
│   ├── rest/
│   │   ├── users-api.json
│   │   └── products-api.json
│   └── graphql/
│       └── main-api.json
├── environments/
│   ├── development.json
│   ├── staging.json
│   └── production.json
├── .gitignore
└── README.md

​

.gitignore Template

# Secrets
*.secret.json
secrets/
.env

# Local state
.local/
*.local.json
history/

# System files
.DS_Store
Thumbs.db

​

Commit Messages

Update collections: Added new endpoint
Update environments: Changed API URL
Sync: 3 collections updated

​

Team Collaboration

1. Communicate - Tell team before major changes
2. Sync Often - Reduce merge conflicts
3. Use Branches - For experimental changes
4. Review Changes - Check diffs before pushing
5. Document - Add README to repository

​

Advanced Configuration

​

Multiple Remotes

# Add backup remote
git remote add backup [email protected]:username/backup.git

# Push to both
git push origin main
git push backup main

​

Custom Git Commands

# Navigate to workspace
cd ~/Documents/Auk/my-workspace

# View commit history
git log --oneline

# View changes
git diff

# Create branch
git checkout -b feature-branch

# Merge branch
git merge feature-branch

​

Hooks

# Pre-commit hook
# .git/hooks/pre-commit
#!/bin/bash
echo "Running pre-commit checks..."
# Add your checks here

​

Next Steps