Skip to main content

​
Offline Capabilities

Auk is designed to work perfectly offline. All core features are available without internet connection.

Full Functionality

All features work offline

Local Storage

Data stored on your device

No Sync Required

Work without syncing

Sync When Ready

Sync when internet returns

​
What Works Offline

​
Fully Available

Everything works without internet:
  • ✅ Create/edit collections
  • ✅ Add/modify requests
  • ✅ Manage environments
  • ✅ View request history
  • ✅ Run pre-request scripts
  • ✅ Execute tests
  • ✅ Import/export data
  • ✅ Keyboard shortcuts
  • ✅ All UI features

​
Requires Internet

Only these features need internet:
  • ❌ Git sync (push/pull)
  • ❌ Testing remote APIs
  • ❌ OAuth authentication
  • ❌ Downloading updates

​
Offline Workflow

​
Working Offline

1

Continue Normally

Use Auk as usual - all features available
2

Changes Saved Locally

All changes saved to local disk immediately
3

Git Commits Locally

If auto-commit enabled, changes committed to local Git
4

Sync When Online

When internet returns, sync automatically resumes

​
Testing APIs Offline

Test local APIs without internet: 
{
  "name": "Local Development",
  "variables": [
    {
      "key": "baseUrl",
      "value": "http://localhost:3000"
    }
  ]
}
Local endpoints:
  • http://localhost:3000
  • http://127.0.0.1:8080
  • http://192.168.1.100:3000

​
Offline Scenarios

​
Airplane Mode

Working on a flight:
  1. Before Flight:
    • Sync latest changes
    • Ensure all data is local
    • Test offline access
  2. During Flight:
    • Work normally
    • All changes saved locally
    • No sync attempts
  3. After Landing:
    • Connect to internet
    • Sync automatically resumes
    • Changes pushed to remote

​
Remote Location

Working with limited connectivity: 
{
  "git": {
    "autoSync": false,
    "syncInterval": 0
  }
}
  • Disable auto-sync
  • Work offline
  • Manual sync when connection available

​
Commute

Working on train/bus:
  • Use mobile hotspot when needed
  • Work offline when no signal
  • Sync during stops with WiFi

​
Git Offline Behavior

​
Local Commits

Git commits work offline: 
# Changes committed locally
git log --oneline
# Shows all local commits

# Push when online
git push origin main

​
Sync Queue

When offline, syncs are queued:
  1. Offline: Sync attempts fail gracefully
  2. Changes Queued: Local commits accumulate
  3. Online: All queued changes sync automatically

​
Best Practices

Always sync before disconnecting:
  • Pull latest changes
  • Push your changes
  • Verify sync status
Test with local servers:
  • Docker containers
  • Local development servers
  • Mock APIs
For extended offline work:
{
  "git": {
    "autoSync": false
  }
}
Sync manually when connection available:
  • Click sync button
  • Or Cmd/Ctrl + Shift + S

​
Troubleshooting

Solution:
  • Check internet connection
  • Verify Git credentials
  • Try manual sync
  • Check sync logs
Solution:
Solution:
  • Use local mock servers
  • Test with local APIs
  • Wait for internet connection
  • Use cached responses

​
Next Steps

Local-First Workflow

Local-first best practices

Git Sync

Understand Git synchronization

Data Storage

Learn about local storage

Workspace Settings

Configure sync settings