> ## 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.

# Auk Documentation

> Local-first API development tool

export const PrimaryButton = ({label, href}) => {
  return <a className="group" href={href}>
      <button className="flex items-center space-x-1 font-bold px-4 py-2 bg-primary-dark rounded-md group-hover:opacity-[0.9] text-white group-hover:opacity-[0.9]">
        <span>
          {label}
        </span>
      </button>
    </a>;
};

<img className="block dark:hidden" src="https://mintcdn.com/postdata/oG3TN6vSZdORlIt7/images/hero-light.png?fit=max&auto=format&n=oG3TN6vSZdORlIt7&q=85&s=804680383081cfe27b5588dac15cb734" width="2100" height="960" data-path="images/hero-light.png" />

<img className="hidden dark:block" src="https://mintcdn.com/postdata/oG3TN6vSZdORlIt7/images/hero-dark.png?fit=max&auto=format&n=oG3TN6vSZdORlIt7&q=85&s=7566af7383c80d6904529282ff4337d7" width="2100" height="960" data-path="images/hero-dark.png" />

**Auk is a local-first API development tool.**

Based on Auk, focused on local storage and Git collaboration, no cloud services required, full control over your API data.

<PrimaryButton label="Get Started" href="/documentation/getting-started/introduction" />

<br />

<br />

## Core Features

<CardGroup cols={2}>
  <Card title="🏠 Local First" icon="house">
    All data stored locally, no cloud account required
    <sub>Complete control over your data</sub>
  </Card>

  <Card title="🔄 Git Sync" icon="code-branch">
    Team collaboration via Git, supports GitHub, GitLab, etc.
    <sub>Standard Git workflows for collaboration</sub>
  </Card>

  <Card title="💼 Multi-Workspace" icon="folder-tree">
    Flexible workspace management with independent configurations
    <sub>Separate work and personal projects</sub>
  </Card>

  <Card title="🔒 Data Security" icon="shield-halved">
    Full data control with custom Git services and encryption
    <sub>Your data, your rules</sub>
  </Card>

  <Card title="⚡ High Performance" icon="bolt">
    Desktop app with no network latency
    <sub>Native performance and speed</sub>
  </Card>

  <Card title="🌐 Offline Ready" icon="wifi-slash">
    Work completely offline, sync when needed
    <sub>No internet required</sub>
  </Card>
</CardGroup>

<br />

## Quick Start

<CardGroup cols={2}>
  <Card title="Download Auk" icon="download" href="/documentation/getting-started/installation">
    <sub>
      Download for macOS, Windows, or Linux
    </sub>
  </Card>

  <Card title="Create Workspace" icon="folder-plus" href="/documentation/getting-started/first-workspace">
    <sub>
      Create your first workspace and get started
    </sub>
  </Card>

  <Card title="Setup Git" icon="code-branch" href="/documentation/getting-started/git-setup">
    <sub>
      Optional: Setup Git sync for team collaboration
    </sub>
  </Card>

  <Card title="Import Data" icon="file-import" href="/documentation/features/importer">
    <sub>
      Import from Postman, Insomnia, or Auk
    </sub>
  </Card>
</CardGroup>

<br />

## Why Auk?

<Steps>
  <Step icon="heart" title="Local First">
    Data stored on your device, no privacy concerns or service interruptions
  </Step>

  <Step icon="code-branch" title="Git Collaboration">
    Use familiar Git workflows for team collaboration with branches, merges, and conflict resolution
  </Step>

  <Step icon="gauge-high" title="High Performance">
    Native desktop performance with no network latency
  </Step>

  <Step icon="shield-check" title="Data Security">
    Full control over your data, choose any Git service or self-hosted server
  </Step>

  <Step icon="wifi-slash" title="Offline Work">
    Work completely offline, sync when needed, no network dependency
  </Step>

  <Step icon="users" title="Team Collaboration">
    Share API collections via Git repositories, real-time team collaboration
  </Step>
</Steps>

<br />

## Differences from Hoppscotch Cloud

| Feature        | Hoppscotch (Cloud)     | Auk (Local-first) |
| -------------- | ---------------------- | ----------------- |
| Storage        | Remote cloud           | Local filesystem  |
| Collaboration  | Cloud workspace        | Git repository    |
| Authentication | Account login required | No login needed   |
| Offline        | Limited                | Full support      |
| Data Control   | Managed service        | You own the data  |
| Deployment     | Web + self-host        | Desktop app       |

<br />

## Development Team

Auk is developed by [mamahuhu.io](https://mamahuhu.io) team, based on the open-source project [Hoppscotch](https://github.com/hoppscotch/hoppscotch).

* Website: [auk.mamahuhu.io](https://auk.mamahuhu.io)
* Documentation: [auk.mamahuhu.dev](https://auk.mamahuhu.dev)
* GitHub: [github.com/mamahuhu-io/auk](https://github.com/mamahuhu-io/auk)

<br />

## License

Auk is licensed under the MIT License.