> ## 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.
# Workspace Settings
> Configure and customize your workspace preferences
## Accessing Settings
Open workspace settings:
1. Click workspace name in top navigation
2. Select "Workspace Settings"
* macOS: `Cmd + ,`
* Windows/Linux: `Ctrl + ,`
## General Settings
### Basic Information
Workspace display name
```json theme={null}
{
"name": "ACME Corp APIs"
}
```
Optional workspace description
```json theme={null}
{
"description": "API collections for ACME Corporation projects"
}
```
Local file system path
```json theme={null}
{
"location": "~/Documents/Auk/acme-corp"
}
```
### Default Environment
Environment to load on workspace startup
```json theme={null}
{
"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
Enable Git synchronization
```json theme={null}
{
"git": {
"enabled": true
}
}
```
Remote repository URL
```json theme={null}
{
"git": {
"remoteUrl": "git@github.com:acme/api-collections.git"
}
}
```
Default branch for synchronization
```json theme={null}
{
"git": {
"branch": "main"
}
}
```
### Sync Behavior
Enable automatic synchronization
```json theme={null}
{
"git": {
"autoSync": true
}
}
```
Auto-sync interval in seconds
```json theme={null}
{
"git": {
"syncInterval": 900
}
}
```
Common values:
* `300` - 5 minutes (active collaboration)
* `900` - 15 minutes (default)
* `3600` - 1 hour (less frequent)
Sync before switching workspaces
```json theme={null}
{
"git": {
"syncBeforeSwitch": true
}
}
```
### Conflict Resolution
How to handle merge conflicts
```json theme={null}
{
"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
Automatically commit changes
```json theme={null}
{
"git": {
"autoCommit": true
}
}
```
Template for commit messages
```json theme={null}
{
"git": {
"commitMessageTemplate": "Update {{collection}} - {{timestamp}}"
}
}
```
Available variables:
* `{{collection}}` - Collection name
* `{{timestamp}}` - Current timestamp
* `{{user}}` - Git user name
## Network Settings
### Proxy Configuration
Enable HTTP/HTTPS proxy
```json theme={null}
{
"proxy": {
"enabled": true
}
}
```
Proxy server URL
```json theme={null}
{
"proxy": {
"url": "http://proxy.company.com:8080"
}
}
```
Proxy authentication credentials
```json theme={null}
{
"proxy": {
"auth": {
"username": "user",
"password": "pass"
}
}
}
```
Domains to bypass proxy
```json theme={null}
{
"proxy": {
"bypass": ["localhost", "127.0.0.1", "*.internal.com"]
}
}
```
### Interceptor
Request interceptor mode
```json theme={null}
{
"interceptor": {
"mode": "proxy"
}
}
```
Options:
* `"none"` - Direct requests (default)
* `"proxy"` - Use Auk Agent or configured proxy
* `"proxy"` - System proxy
## Request Settings
### Timeout
Request timeout in milliseconds
```json theme={null}
{
"request": {
"timeout": 30000
}
}
```
### SSL/TLS
Validate SSL certificates
```json theme={null}
{
"request": {
"validateSSL": true
}
}
```
Disabling SSL validation is insecure. Only use for development with self-signed certificates.
Client certificate for mutual TLS
```json theme={null}
{
"request": {
"clientCertificate": {
"cert": "/path/to/cert.pem",
"key": "/path/to/key.pem",
"passphrase": "optional-passphrase"
}
}
}
```
### Headers
Default headers for all requests
```json theme={null}
{
"request": {
"defaultHeaders": [
{
"key": "User-Agent",
"value": "Auk/3.0"
}
]
}
}
```
## UI Settings
### Theme
Application theme
```json theme={null}
{
"ui": {
"theme": "dark"
}
}
```
Options:
* `"system"` - Follow system theme
* `"light"` - Light theme
* `"dark"` - Dark theme
### Font
Base font size in pixels
```json theme={null}
{
"ui": {
"fontSize": 14
}
}
```
Font family for code editor
```json theme={null}
{
"ui": {
"fontFamily": "JetBrains Mono, monospace"
}
}
```
## History Settings
Enable request history
```json theme={null}
{
"history": {
"enabled": true
}
}
```
Maximum history entries to keep
```json theme={null}
{
"history": {
"maxEntries": 1000
}
}
```
Days to retain history
```json theme={null}
{
"history": {
"retentionDays": 30
}
}
```
## Example Configurations
### Minimal Configuration
```json theme={null}
{
"name": "Personal APIs",
"location": "~/Documents/Auk/personal",
"defaultEnvironment": "development"
}
```
### Team Workspace with Git
```json theme={null}
{
"name": "ACME Corp APIs",
"location": "~/Documents/Auk/acme-corp",
"defaultEnvironment": "development",
"git": {
"enabled": true,
"remoteUrl": "git@github.com:acme/api-collections.git",
"branch": "main",
"autoSync": true,
"syncInterval": 900,
"conflictResolution": "prompt"
}
}
```
### Corporate Environment with Proxy
```json theme={null}
{
"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
Configure Git synchronization
Manage environment variables
Configure network settings
Customize keyboard shortcuts