Skip to main content

​
System Requirements

Auk supports the following operating systems:
  • macOS 10.15 (Catalina) or later
  • Windows 10 or later
  • Linux Ubuntu 20.04 or other major distributions

​
Download Auk

Choose the version for your operating system:

Apple Silicon (.dmg)

For M1/M2/M3 MacsDownload

Intel (.dmg)

For Intel-based MacsDownload

Windows Installer (.msi)

Recommended: Installer with auto-configurationDownload

Portable (.exe)

Portable version, no installation requiredDownload

Debian/Ubuntu (.deb)

For Debian-based distributionsDownload

AppImage

Universal format for all distributionsDownload

​
Installation Steps

​
macOS

  1. Download the .dmg file for your Mac
  2. Double-click to open the .dmg file
  3. Drag the Auk icon to the Applications folder
  4. First time: right-click Auk and select “Open”
  5. If you see a security prompt, click “Open” to confirm
macOS may show “cannot verify developer”. This is normal for open-source software.Solution: System Preferences → Security & Privacy → Click “Open Anyway”

​
Windows

​
Using Installer

  1. Download the .msi installer
  2. Double-click to run the installer
  3. Follow the installation wizard
  4. After installation, launch Auk from Start menu

​
Using Portable Version

  1. Download the .zip archive
  2. Extract to any directory
  3. Run Auk.exe
Windows may show SmartScreen warning. Click “More info” then “Run anyway”.

​
Linux

​
Debian/Ubuntu (.deb)

# After downloading the .deb file

# Install
sudo dpkg -i Auk_linux_x64.deb

# If there are dependency issues, run
sudo apt-get install -f

# Launch Auk
auk

​
AppImage

# After downloading the .AppImage file

# Add execute permission
chmod +x Auk_linux_x64.AppImage

# Run
./Auk_linux_x64.AppImage
Recommended to move AppImage to ~/Applications or /opt directory

​
Verify Installation

After installation, launching Auk should show the welcome screen.
1

Launch App

Launch Auk from applications list or command line
2

Check Version

Click Menu → About Auk to see version number
3

Create Workspace

First launch will guide you to create your first workspace

​
Update Auk

Auk automatically checks for updates. When a new version is available:
  1. Update notification will appear in the app
  2. Click “Download Update”
  3. Restart the app after download completes

​
Manual Update

If automatic update fails, manually download the latest version:
  1. Visit GitHub Releases
  2. Download the installer for your platform
  3. Install the new version (will overwrite old version)
  4. Your data and settings will be preserved

​
Uninstall Auk

​
macOS

  1. Open Finder → Applications
  2. Drag Auk to Trash
  3. Empty Trash
  4. (Optional) Delete data directory: ~/Library/Application Support/io.mamahuhu.auk

​
Windows

  1. Open “Settings” → “Apps”
  2. Find Auk and click “Uninstall”
  3. (Optional) Delete data directory: %APPDATA%\io.mamahuhu.auk

​
Linux

# Debian/Ubuntu
sudo apt remove auk

# Delete data directory (optional)
rm -rf ~/.local/share/io.mamahuhu.auk

​
Data Location

Auk stores data in the following locations:
PlatformData Directory
macOS~/Library/Application Support/io.mamahuhu.auk
Windows%APPDATA%\io.mamahuhu.auk
Linux~/.local/share/io.mamahuhu.auk
Data directory contains:
  • workspaces.json - Workspace configuration
  • settings.json - App settings
  • workspaces/ - Data for each workspace
Uninstalling the app does not automatically delete the data directory. Delete manually if needed.

​
Troubleshooting

​
App Won’t Start

macOS:
  • Check if blocked by Gatekeeper: System Preferences → Security & Privacy
Windows:
  • Check if blocked by antivirus software
  • Try running as administrator
Linux:
  • Check execute permission: chmod +x Auk
  • Check dependencies: ldd Auk

​
Update Failed

  1. Check network connection
  2. Manually download latest version
  3. Backup data directory and reinstall

​
Data Loss

If data is lost, check:
  1. Data directory exists
  2. Workspace path is correct
  3. Check backups (if Git sync is enabled)

​
Next Steps

Create Workspace

Create your first workspace

Setup Git

Setup Git sync (optional)

Quick Start

Quick start guide

Import Data

Import data from other tools