Skip to main content

​
Accessing Settings

Open workspace settings:
  1. Click workspace name in top navigation
  2. Select “Workspace Settings”

​
General Settings

​
Basic Information

​
name
string
required
Workspace display name
{
  "name": "ACME Corp APIs"
}
​
description
string
Optional workspace description
{
  "description": "API collections for ACME Corporation projects"
}
​
location
path
required
Local file system path
{
  "location": "~/Documents/Auk/acme-corp"
}

​
Default Environment

​
defaultEnvironment
string
Environment to load on workspace startup
{
  "defaultEnvironment": "development"
}
Options:
  • null - No default environment
  • "development" - Development environment
  • "staging" - Staging environment
  • "production" - Production environment
  • Any custom environment name

​
Git Sync Settings

​
Repository Configuration

​
git.enabled
boolean
default:"false"
Enable Git synchronization
{
  "git": {
    "enabled": true
  }
}
​
git.remoteUrl
string
Remote repository URL
{
  "git": {
    "remoteUrl": "[email protected]:acme/api-collections.git"
  }
}
​
git.branch
string
default:"main"
Default branch for synchronization
{
  "git": {
    "branch": "main"
  }
}

​
Sync Behavior

​
git.autoSync
boolean
default:"false"
Enable automatic synchronization
{
  "git": {
    "autoSync": true
  }
}
​
git.syncInterval
number
default:"900"
Auto-sync interval in seconds
{
  "git": {
    "syncInterval": 900
  }
}
Common values:
  • 300 - 5 minutes (active collaboration)
  • 900 - 15 minutes (default)
  • 3600 - 1 hour (less frequent)
​
git.syncBeforeSwitch
boolean
default:"true"
Sync before switching workspaces
{
  "git": {
    "syncBeforeSwitch": true
  }
}

​
Conflict Resolution

​
git.conflictResolution
string
default:"prompt"
How to handle merge conflicts
{
  "git": {
    "conflictResolution": "prompt"
  }
}
Options:
  • "prompt" - Ask user for each conflict (default)
  • "keepLocal" - Always keep local changes
  • "useRemote" - Always use remote changes
  • "smartMerge" - Attempt automatic merge

​
Commit Settings

​
git.autoCommit
boolean
default:"true"
Automatically commit changes
{
  "git": {
    "autoCommit": true
  }
}
​
git.commitMessageTemplate
string
Template for commit messages
{
  "git": {
    "commitMessageTemplate": "Update {{collection}} - {{timestamp}}"
  }
}
Available variables:
  • {{collection}} - Collection name
  • {{timestamp}} - Current timestamp
  • {{user}} - Git user name

​
Network Settings

​
Proxy Configuration

​
proxy.enabled
boolean
default:"false"
Enable HTTP/HTTPS proxy
{
  "proxy": {
    "enabled": true
  }
}
​
proxy.url
string
Proxy server URL
{
  "proxy": {
    "url": "http://proxy.company.com:8080"
  }
}
​
proxy.auth
object
Proxy authentication credentials
{
  "proxy": {
    "auth": {
      "username": "user",
      "password": "pass"
    }
  }
}
​
proxy.bypass
array
Domains to bypass proxy
{
  "proxy": {
    "bypass": ["localhost", "127.0.0.1", "*.internal.com"]
  }
}

​
Interceptor

​
interceptor.mode
string
default:"none"
Request interceptor mode
{
  "interceptor": {
    "mode": "proxy"
  }
}
Options:
  • "none" - Direct requests (default)
  • "proxy" - Use Auk Agent or configured proxy
  • "proxy" - System proxy

​
Request Settings

​
Timeout

​
request.timeout
number
default:"30000"
Request timeout in milliseconds
{
  "request": {
    "timeout": 30000
  }
}

​
SSL/TLS

​
request.validateSSL
boolean
default:"true"
Validate SSL certificates
{
  "request": {
    "validateSSL": true
  }
}
Disabling SSL validation is insecure. Only use for development with self-signed certificates.
​
request.clientCertificate
object
Client certificate for mutual TLS
{
  "request": {
    "clientCertificate": {
      "cert": "/path/to/cert.pem",
      "key": "/path/to/key.pem",
      "passphrase": "optional-passphrase"
    }
  }
}

​
Headers

​
request.defaultHeaders
array
Default headers for all requests
{
  "request": {
    "defaultHeaders": [
      {
        "key": "User-Agent",
        "value": "Auk/3.0"
      }
    ]
  }
}

​
UI Settings

​
Theme

​
ui.theme
string
default:"system"
Application theme
{
  "ui": {
    "theme": "dark"
  }
}
Options:
  • "system" - Follow system theme
  • "light" - Light theme
  • "dark" - Dark theme

​
Font

​
ui.fontSize
number
default:"14"
Base font size in pixels
{
  "ui": {
    "fontSize": 14
  }
}
​
ui.fontFamily
string
Font family for code editor
{
  "ui": {
    "fontFamily": "JetBrains Mono, monospace"
  }
}

​
History Settings

​
history.enabled
boolean
default:"true"
Enable request history
{
  "history": {
    "enabled": true
  }
}
​
history.maxEntries
number
default:"1000"
Maximum history entries to keep
{
  "history": {
    "maxEntries": 1000
  }
}
​
history.retentionDays
number
default:"30"
Days to retain history
{
  "history": {
    "retentionDays": 30
  }
}

​
Example Configurations

​
Minimal Configuration

{
  "name": "Personal APIs",
  "location": "~/Documents/Auk/personal",
  "defaultEnvironment": "development"
}

​
Team Workspace with Git

{
  "name": "ACME Corp APIs",
  "location": "~/Documents/Auk/acme-corp",
  "defaultEnvironment": "development",
  "git": {
    "enabled": true,
    "remoteUrl": "[email protected]:acme/api-collections.git",
    "branch": "main",
    "autoSync": true,
    "syncInterval": 900,
    "conflictResolution": "prompt"
  }
}

​
Corporate Environment with Proxy

{
  "name": "Corporate APIs",
  "location": "~/Documents/Auk/corporate",
  "proxy": {
    "enabled": true,
    "url": "http://proxy.company.com:8080",
    "auth": {
      "username": "user",
      "password": "pass"
    },
    "bypass": ["localhost", "*.internal.com"]
  },
  "request": {
    "validateSSL": false,
    "clientCertificate": {
      "cert": "/path/to/cert.pem",
      "key": "/path/to/key.pem"
    }
  }
}

​
Next Steps

Git Sync Setup

Configure Git synchronization

Environments

Manage environment variables

Proxy & Interceptor

Configure network settings

Keyboard Shortcuts

Customize keyboard shortcuts