Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auk.mamahuhu.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Quick Switching

Auk makes it easy to switch between workspaces without losing your current context.

​
Using the Workspace Selector

1

Click Workspace Name

Click the current workspace name in the top navigation bar
2

Select Workspace

Choose the workspace you want to switch to from the dropdown
3

Instant Switch

Auk immediately loads the selected workspace

​
Keyboard Shortcuts

  • Cmd + Shift + W - Open workspace switcher
  • Cmd + 1-9 - Switch to workspace 1-9
  • Cmd + Shift + N - Create new workspace

​
Workspace Switcher

The workspace switcher provides a quick overview of all your workspaces: 
┌─────────────────────────────────────┐
│ Workspaces                          │
├─────────────────────────────────────┤
│ ✓ acme-corp-apis                    │
│   Last used: 2 minutes ago          │
│   📁 ~/Documents/Auk/acme-corp      │
│   🔄 Git: Synced                    │
├─────────────────────────────────────┤
│   personal-projects                 │
│   Last used: 1 hour ago             │
│   📁 ~/Documents/Auk/personal       │
│   🔄 Git: Not configured            │
├─────────────────────────────────────┤
│   client-globex                     │
│   Last used: Yesterday              │
│   📁 ~/Projects/clients/globex      │
│   🔄 Git: 3 changes pending         │
├─────────────────────────────────────┤
│ + Create New Workspace              │
└─────────────────────────────────────┘

​
Recent Workspaces

Auk remembers your recently used workspaces for quick access:
  • Most Recent - Appears at the top of the list
  • Quick Access - Use number shortcuts (Cmd/Ctrl + 1-9)
  • Last Used Time - See when you last worked in each workspace

​
Workspace States

​
Active Workspace

The currently open workspace:
  • ✓ Checkmark indicator
  • Highlighted in the switcher
  • Shown in the title bar

​
Synced Workspace

Workspace with Git sync enabled and up-to-date:
  • 🔄 Sync indicator shows “Synced”
  • Green status dot
  • No pending changes

​
Pending Changes

Workspace with uncommitted or unpushed changes:
  • 🔄 Sync indicator shows “X changes pending”
  • Yellow status dot
  • Click to view changes

​
Sync Error

Workspace with sync errors:
  • ⚠️ Warning indicator
  • Red status dot
  • Click to view error details

​
Auto-Save Before Switching

Auk automatically saves your work before switching:
1

Save Current State

All unsaved changes are saved automatically
2

Commit to Git (if enabled)

Changes are committed to local Git repository
3

Switch Workspace

New workspace is loaded
4

Restore State

Previous workspace state is preserved for when you return

​
Managing Multiple Workspaces

​
Organizing Workspaces

Use naming conventions to keep workspaces organized: 
Work Workspaces:
├── work-backend-apis
├── work-frontend-apis
└── work-internal-tools

Client Workspaces:
├── client-acme
├── client-globex
└── client-initech

Personal Workspaces:
├── personal-projects
└── personal-learning

​
Workspace Groups (Coming Soon)

Future feature to group related workspaces: 
📁 Work
  ├── Backend APIs
  ├── Frontend APIs
  └── Internal Tools

📁 Clients
  ├── ACME Corp
  ├── Globex
  └── Initech

📁 Personal
  ├── Projects
  └── Learning

​
Sync Before Switching

For workspaces with Git sync enabled, consider syncing before switching:

​
Manual Sync

1. Click sync button in workspace switcher
2. Wait for sync to complete
3. Switch to new workspace

​
Auto-Sync

Enable auto-sync to ensure workspaces are always up-to-date: 
{
  "git": {
    "autoSync": true,
    "syncBeforeSwitch": true
  }
}

​
Best Practices

Always sync workspaces with Git before switching to avoid conflicts:
  • Ensures latest changes are pushed
  • Prevents merge conflicts
  • Keeps team members in sync
Name workspaces clearly to identify them quickly:
  • ✅ acme-corp-backend-apis
  • ✅ personal-learning-projects
  • ❌ workspace-1
  • ❌ test
Remove workspaces you no longer need:
  • Keeps workspace list manageable
  • Reduces clutter
  • Improves performance
Backup important workspaces regularly:
  • Use Git sync for automatic backups
  • Create manual backups for critical data
  • Test restore procedures

​
Workspace Context

When switching workspaces, Auk preserves:
  • ✅ Collections - All API collections
  • ✅ Environments - Environment variables and active environment
  • ✅ History - Request history
  • ✅ Settings - Workspace-specific settings
  • ✅ Git State - Uncommitted changes and sync status
Auk does NOT preserve:
  • ❌ Open Tabs - Tabs are workspace-specific
  • ❌ UI State - Sidebar state, panel sizes, etc.
  • ❌ Temporary Data - Clipboard, search queries, etc.

​
Troubleshooting

Cause: Unsaved changes or sync in progressSolution:
  • Wait for current sync to complete
  • Check for error messages
  • Try force-switching (may lose unsaved changes)
Cause: Data not loaded or corruptedSolution:
  • Refresh the workspace (Cmd/Ctrl + R)
  • Check workspace directory exists
  • Restore from backup if needed
Cause: Workspace removed or movedSolution:
  • Check workspace directory still exists
  • Re-add workspace if moved
  • Create new workspace if deleted

​
Next Steps

Workspace Settings

Configure workspace preferences

Git Sync

Set up Git synchronization

Keyboard Shortcuts

Learn all keyboard shortcuts

Data Management

Understand workspace data storage