Skip to main content

​
What is a Workspace?

A workspace in Auk is an isolated environment for organizing your API collections, environments, and settings. Each workspace operates independently with its own local storage and optional Git repository.

​
Key Features

Data Isolation

Each workspace has completely separate data - collections, environments, and history never mix between workspaces

Independent Git

Configure different Git repositories for each workspace, enabling separate version control strategies

Custom Settings

Each workspace can have its own proxy settings, interceptor configuration, and preferences

Quick Switching

Instantly switch between workspaces without losing context or closing the application

​
Use Cases

​
Separate Work and Personal Projects

~/auk-workspaces/
├── work/
│   ├── collections/
│   ├── environments/
│   └── .git/              # Synced to company Git server
└── personal/
    ├── collections/
    ├── environments/
    └── .git/              # Synced to personal GitHub

​
Multi-Client Management

~/auk-workspaces/
├── client-acme/
│   └── .git/              # Client A's private repo
├── client-globex/
│   └── .git/              # Client B's private repo
└── internal/
    └── .git/              # Company internal repo

​
Project-Based Organization

~/auk-workspaces/
├── project-alpha/
├── project-beta/
└── project-gamma/

​
Workspace Structure

Each workspace contains: 
workspace-name/
├── collections/           # API collections
│   ├── collection-1.json
│   └── collection-2.json
├── environments/          # Environment variables
│   ├── dev.json
│   ├── staging.json
│   └── production.json
├── history/              # Request history
│   └── history.json
├── settings.json         # Workspace settings
└── .git/                # Optional Git repository

​
Workspace Settings

Each workspace can be configured with:
  • Name and Description - Identify the workspace purpose
  • Storage Location - Local file system path
  • Git Repository - Remote repository URL (optional)
  • Sync Settings - Auto-sync interval and conflict resolution strategy
  • Default Environment - Environment to load on startup
  • Proxy Configuration - HTTP/HTTPS proxy settings
  • Interceptor Mode - System proxy/Agent or none

​
Best Practices

Name workspaces clearly to reflect their purpose:
  • ✅ acme-corp-apis
  • ✅ personal-projects
  • ❌ workspace-1
  • ❌ test
Group related APIs together:
  • By client/customer
  • By project
  • By environment (dev/staging/prod)
  • By team
For collaborative work, always configure Git sync to ensure team members stay in sync
Use separate workspaces for work and personal projects to maintain clear boundaries

​
Next Steps

Create a Workspace

Learn how to create and configure your first workspace

Switch Workspaces

Master workspace switching and management

Git Sync Setup

Configure Git synchronization for team collaboration

Workspace Settings

Explore all available workspace configuration options