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.
Finding Your Data Auk stores all workspace data on your local file system. Here’s how to locate it:
Default Storage Locations Application Support Directory ~ /Library/Application Support/Auk/
Full path: /Users/YourUsername/Library/Application Support/Auk/
Quick Access # Open in Finder open ~/Library/Application \ Support/Auk/ # List workspaces ls -la ~/Library/Application \ Support/Auk/workspaces/ # Navigate in Terminal cd ~/Library/Application \ Support/Auk/workspaces/
The ~/Library folder is hidden by default. Use Cmd + Shift + . in Finder to show hidden files.
AppData Directory Full path: C:\Users\YourUsername\AppData\Roaming\Auk\
Quick Access # Open in Explorer explorer %APPDATA% \A uk # List workspaces dir %APPDATA% \A uk \w orkspaces # Navigate in Command Prompt cd %APPDATA% \A uk \w orkspaces
The AppData folder is hidden by default. Enable “Show hidden files” in Explorer options.
Config Directory Full path: /home/yourusername/.config/Auk/
Quick Access # Open in file manager xdg-open ~/.config/Auk/ # List workspaces ls -la ~/.config/Auk/workspaces/ # Navigate in Terminal cd ~/.config/Auk/workspaces/
Directory Structure Complete Layout Auk/ ├── workspaces/ # All workspaces │ ├── my-workspace/ │ │ ├── collections/ │ │ ├── environments/ │ │ ├── history/ │ │ ├── settings.json │ │ └── .git/ │ ├── another-workspace/ │ └── client-project/ ├── settings/ # Global settings │ ├── app-settings.json │ ├── keybindings.json │ └── recent-workspaces.json ├── logs/ # Application logs │ ├── app.log │ ├── git-sync.log │ └── error.log ├── cache/ # Temporary cache │ └── icons/ └── backups/ # Automatic backups └── 2024-02-20/
Workspace Directory Each workspace contains:
my-workspace/ ├── collections/ # API collections │ ├── user-api.json # Collection file │ ├── payment-api.json │ └── .backups/ # Collection backups │ └── user-api.json.2024-02-20 ├── environments/ # Environment variables │ ├── development.json │ ├── staging.json │ └── production.json ├── history/ # Request history │ ├── 2024-01.json # Monthly history │ ├── 2024-02.json │ └── current.json # Current month ├── settings.json # Workspace settings ├── .git/ # Git repository (if enabled) ├── .gitignore # Git ignore rules └── README.md # Workspace documentation
Custom Storage Locations You can store workspaces anywhere on your file system:
Setting Custom Location When creating a workspace:
Create Workspace
Click “New Workspace” in workspace selector
Choose Location
Click “Choose Custom Location”
Select Directory
Browse to desired location:
~/Documents/Auk/~/Projects/api-collections//Volumes/External/Auk/
Create
Workspace is created at chosen location
Common Custom Locations Documents
Projects
External Drive
Cloud Sync
# macOS/Linux ~ /Documents/Auk/workspaces/ # Windows C:\Users\YourUsername\Documents\Auk\workspaces\
Advantages:
Easy to find
Included in user backups
Accessible from file manager
# macOS/Linux ~ /Projects/api-collections/ # Windows C:\Users\YourUsername\Projects\api-collections\
Advantages:
Organized with other projects
Easy to share with team
Clear project structure
# macOS /Volumes/External/Auk/ # Windows D:\Auk\ # Linux /mnt/external/Auk/
Advantages:
Large storage capacity
Easy to move between computers
Physical backup
# Dropbox ~ /Dropbox/Auk/ # Google Drive ~ /Google Drive/Auk/ # OneDrive ~ /OneDrive/Auk/
Advantages:
Automatic cloud backup
Access from multiple devices
Built-in version history
Don’t use both Git sync and cloud sync together - may cause conflicts
Finding Specific Data Find a Collection # macOS/Linux find ~/Library/Application \ Support/Auk/workspaces/ -name "*.json" -path "*/collections/*" # Windows dir /s /b %APPDATA% \A uk \w orkspaces \*\c ollections \* .json
Find an Environment # macOS/Linux find ~/Library/Application \ Support/Auk/workspaces/ -name "*.json" -path "*/environments/*" # Windows dir /s /b %APPDATA% \A uk \w orkspaces \*\e nvironments \* .json
Search Collection Content # macOS/Linux - Search for endpoint grep -r "api.example.com" ~/Library/Application \ Support/Auk/workspaces/ * /collections/ # Windows - Search for endpoint findstr /s /i "api.example.com" %APPDATA% \A uk \w orkspaces \*\c ollections \* .json
Viewing Data In Auk
Workspace Settings → “Open Workspace Folder”Opens workspace directory in file manager
In File Manager macOS Finder
Windows Explorer
Linux File Manager
# Open workspace folder open ~/Library/Application \ Support/Auk/workspaces/my-workspace/ # Show in Finder # Right-click workspace in Auk → "Show in Finder"
# Open workspace folder explorer %APPDATA% \A uk \w orkspaces \m y-workspace # Show in Explorer # Right-click workspace in Auk → "Show in Explorer"
# Open workspace folder xdg-open ~/.config/Auk/workspaces/my-workspace/ # Or use your file manager nautilus ~/.config/Auk/workspaces/my-workspace/
In Text Editor # VS Code code ~/Library/Application \ Support/Auk/workspaces/my-workspace/ # Sublime Text subl ~/Library/Application \ Support/Auk/workspaces/my-workspace/ # Vim vim ~/Library/Application \ Support/Auk/workspaces/my-workspace/collections/user-api.json
Moving Data Move Workspace to New Location
Close Auk
Ensure Auk is not running
Move Directory
# macOS/Linux mv ~/Library/Application \ Support/Auk/workspaces/my-workspace \ ~/Documents/Auk/my-workspace # Windows move %APPDATA% \A uk \w orkspaces \m y-workspace ^ C:\Users\YourUsername\Documents\Auk\my-workspace
Update Auk
Open Auk and update workspace location in settings
Verify
Ensure all collections and environments are accessible
Move Between Computers Via Git
Via Archive
Via Cloud Sync
On Computer A: # Push to Git cd workspace-directory git push origin main
On Computer B: Then open workspace in Auk On Computer A: # Create archive tar -czf my-workspace.tar.gz \ ~/Library/Application \ Support/Auk/workspaces/my-workspace/
On Computer B: # Extract archive tar -xzf my-workspace.tar.gz -C \ ~/Library/Application \ Support/Auk/workspaces/
Move workspace to cloud sync folder (Dropbox/Drive)
Wait for sync to complete
On other computer, open workspace from cloud folder
Storage Management Check Disk Usage # Total Auk storage du -sh ~/Library/Application \ Support/Auk/ # Per workspace du -sh ~/Library/Application \ Support/Auk/workspaces/ * / # Detailed breakdown du -h ~/Library/Application \ Support/Auk/ | sort -h
# Total Auk storage dir %APPDATA% \A uk /s # Per workspace dir %APPDATA% \A uk \w orkspaces /s
Clean Up Space
# Delete history older than 30 days find ~/Library/Application \ Support/Auk/workspaces/ * /history/ \ -name "*.json" -mtime +30 -delete
Or configure in settings: { "history" : { "retentionDays" : 30 } }
# macOS rm -rf ~/Library/Caches/Auk/ * # Windows del /s /q %LOCALAPPDATA% \A uk \c ache \* # Linux rm -rf ~/.cache/Auk/ *
# Delete backups older than 7 days find ~/Library/Application \ Support/Auk/workspaces/ * /.backups/ \ -name "*.json.*" -mtime +7 -delete
# Compress old history files find ~/Library/Application \ Support/Auk/workspaces/ * /history/ \ -name "*.json" -mtime +90 -exec gzip {} \;
Troubleshooting
Cannot find workspace data
Solutions:
Check default location for your OS
Search for workspace name:
# macOS/Linux find ~ -name "my-workspace" -type d # Windows dir /s /b C: \U sers \Y ourUsername \* my-workspace *
Check Auk settings for custom locations
Workspace folder is empty
Causes:
Workspace not yet synced
Data corruption
Wrong directory
Solutions:
Check if Git sync is enabled and sync
Restore from backup
Verify correct workspace directory
Solutions: # macOS/Linux - Fix permissions chmod -R 700 ~/Library/Application \ Support/Auk/workspaces/my-workspace/ # Windows - Run as administrator # Right-click Auk → Run as administrator
Next Steps
File System Storage Learn about file system storage
Backup & Restore Backup and recovery strategies
Workspace Settings Configure workspace options
Git Sync Set up Git synchronization
