Migrate from Auk Cloud

​

Why Migrate to Auk?

​

Migration Overview

1. Export collections from Auk
2. Export environments from Auk
3. Import into Auk workspace
4. Configure Git sync for collaboration
5. Verify and test

​

Step 1: Export from Auk Cloud

​

Export Collections

​

Export Environments

​

Step 2: Create Auk Workspace

​

Setup Workspace

1. Launch Auk
2. Create a new workspace
3. Choose storage location
4. Name it after your Auk workspace

​

Workspace Mapping

- Personal Workspace
- Team A Workspace
- Team B Workspace

- Personal (local workspace)
- Team-A (Git-synced workspace)
- Team-B (Git-synced workspace)

​

Step 3: Import Collections

​

Import Process

​

What Gets Imported

• ✅ Collections and folders
• ✅ REST requests
• ✅ GraphQL queries
• ✅ WebSocket connections
• ✅ Request headers
• ✅ Request bodies
• ✅ Query parameters
• ✅ Authentication settings
• ✅ Pre-request scripts
• ✅ Test scripts

• ❌ Team workspace settings (use Git)
• ❌ User preferences (configure in Auk)
• ❌ History (starts fresh in Auk)
• ❌ Cloud sync settings (use Git sync)

​

Step 4: Import Environments

​

Import Environment

​

Environment Types

​

Step 5: Configure Git Sync

​

Create Git Repository

1. Create repository on GitHub/GitLab
2. Initialize with README
3. Keep it private for team data

​

Configure in Auk

1. Open workspace settings
2. Enable Git sync
3. Enter repository URL
4. Configure authentication
5. Initial push

​

Share with Team

1. Share repository URL with team
2. Team members create Auk workspace
3. Configure same Git repository
4. Pull to get collections
5. Set their own secret values

​

Step 6: Verify Migration

​

Check Collections

• All collections imported
• Folder hierarchy preserved
• Request names correct
• Request types correct (REST/GraphQL/WebSocket)

• URLs correct
• HTTP methods correct
• Headers present
• Bodies intact
• Authentication configured
• Scripts working

​

Check Environments

• All variables imported
• Variable names correct
• Values correct
• Secret variables marked

• Variables resolve in requests
• Environment switching works
• Variable precedence correct

​

Test Functionality

1. Send REST requests
2. Test GraphQL queries
3. Test WebSocket connections
4. Verify authentication
5. Test scripts
6. Check variable substitution

​

Feature Mapping

​

Auk → Auk Features

​

Variable Syntax

<<baseUrl>>/<<apiVersion>>/users

​

Script API

// Both work the same
pw.env.set("token", "value");
pw.test("Status is 200", () => {
  pw.expect(pw.response.status).toBe(200);
});

​

Differences to Note

​

Team Collaboration

• Real-time sync
• User roles (Owner, Editor, Viewer)
• Invite by email
• Cloud-based

• Git-based sync (periodic)
• Git permissions (Read, Write, Admin)
• Share repository URL
• Local-first

​

Authentication

• Requires login (Google, GitHub, Email)
• User accounts
• Team management

• No login required
• No user accounts
• Git-based team management

​

Data Storage

• Stored in Firebase/PostgreSQL
• Accessible from any device
• Requires internet

• Stored locally
• Accessible offline
• Sync via Git when needed

​

Common Issues and Solutions

​

Issue: Collections Not Importing

1. Verify JSON file is valid
2. Check file is Auk format
3. Try exporting again
4. Check file size
5. Import collections individually

​

Issue: Team Workspace Data

1. Ensure you have Owner/Editor role
2. Export from team workspace view
3. Contact workspace owner
4. Export individual collections

​

Issue: History Not Imported

• History is not exported by Auk
• History stays local in Auk
• Start fresh history in Auk
• Old history remains in Auk

​

Issue: Real-time Sync

• Auk uses Git sync (periodic, not real-time)
• Configure shorter sync interval
• Manually trigger sync
• Communicate major changes to team

​

Issue: User Roles

• Use Git repository permissions
• GitHub/GitLab have role systems
• Read, Write, Admin permissions
• Configure in Git service

​

Migration Checklist

​

Pre-Migration

• List all Auk workspaces
• Identify personal vs team workspaces
• Document team members
• Document secret variables
• Plan Auk workspace structure
• Create Git repositories (for team workspaces)

​

Export Phase

• Export all collections
• Export all environments
• Export from each workspace
• Save all export files
• Verify exports complete

​

Import Phase

• Create Auk workspaces
• Import collections
• Import environments
• Set secret values
• Configure Git sync (team workspaces)
• Test sample requests

​

Verification Phase

• All collections present
• All requests working
• All environments configured
• Variables resolving
• Scripts executing
• Authentication working
• Git sync working (team workspaces)

​

Team Migration

• Share Git repository URLs
• Team members install Auk
• Team members create workspaces
• Team members configure Git
• Team members set secrets
• Verify team collaboration

​

Post-Migration

• Update documentation
• Train team members
• Monitor for issues
• Gather feedback
• Archive Auk data

​

Team Migration Strategy

​

Communication Plan

Subject: Migrating from Auk Cloud to Auk

Hi Team,

We're migrating from Auk Cloud to Auk for the following benefits:
- Local-first: Full offline support
- Privacy: Data on our devices
- Cost: Free forever
- Git-based: Standard collaboration

Timeline:
- Week 1: Pilot with 2 team members
- Week 2: Full team migration
- Week 3: Decommission Auk

Resources:
- Installation guide: [link]
- Migration guide: [link]
- Support channel: #auk-migration

Questions? Let's discuss!

​

Training Materials

1. Installation Guide
   • Download Auk
   • Install on macOS/Windows/Linux
   • First launch
2. Migration Guide
   • Import collections
   • Configure Git
   • Set secrets
3. Daily Usage
   • Send requests
   • Switch environments
   • Sync with Git
4. Troubleshooting
   • Common issues
   • Solutions
   • Support contacts

​

Advantages of Auk

​

For Individual Developers

• No Login: Start using immediately
• Offline: Work anywhere
• Fast: No network latency
• Private: Data stays local
• Free: No subscription

​

For Teams

• Git-based: Standard workflows
• Version Control: Full history
• Branching: Feature branches
• Pull Requests: Code review
• No Costs: Free for unlimited users

​

For Organizations

• Self-hosted Git: Complete control
• Compliance: Data stays on-premise
• Security: No external dependencies
• Audit Trail: Git history
• Scalable: No per-user costs

​

Cost Comparison

Team Size: 10 users
Plan: Free tier (limited features)
Or Pro: $10/user/month = $1,200/year

Team Size: 10 users
Plan: Free (all features)
Annual Cost: $0/year

Optional Git Hosting:
- GitHub Free: $0/year
- GitLab Free: $0/year
- Self-hosted: One-time setup

Total: $0/year

​

Next Steps

​

Support

• Documentation: auk.mamahuhu.dev
• GitHub Issues: github.com/mamahuhu-io/auk/issues
• Community: Join our discussions