# Auk Documentation

> Local-first API development tool

## Docs

- [Changelog](https://auk.mamahuhu.dev/documentation/changelog.md): New updates and improvements to Auk.
- [Auk CLI](https://auk.mamahuhu.dev/documentation/clients/cli/overview.md): Run tests, manage automated API monitoring, and more.
- [Auk CLI Troubleshooting](https://auk.mamahuhu.dev/documentation/clients/cli/troubleshooting.md): Troubleshoot the CLI errors by understanding their meanings and possible causes.
- [Auk Desktop App](https://auk.mamahuhu.dev/documentation/clients/desktop.md): Cross-platform desktop application that runs on macOS, Windows, and Linux.
- [Data Storage](https://auk.mamahuhu.dev/documentation/concepts/data-storage.md): Understanding how Auk stores your data locally
- [Git Sync](https://auk.mamahuhu.dev/documentation/concepts/git-sync.md): Team collaboration through Git version control
- [Local-First Architecture](https://auk.mamahuhu.dev/documentation/concepts/local-first.md): Understanding Auk's local-first approach to API development
- [Workspaces](https://auk.mamahuhu.dev/documentation/concepts/workspaces.md): Organize your API projects with independent workspaces
- [Authorization](https://auk.mamahuhu.dev/documentation/features/authorization.md): Authorization is the process of verifying that a client has permission to access a resource.
- [Client Certificate](https://auk.mamahuhu.dev/documentation/features/client-certificate.md): Configure client certificates for SSL authentication in Auk.
- [Collections](https://auk.mamahuhu.dev/documentation/features/collections.md): Save, organize, and version control your API requests with collections
- [Cookies](https://auk.mamahuhu.dev/documentation/features/cookies.md): Create and modify cookies associated with a domain and send cookies with requests.
- [Customization](https://auk.mamahuhu.dev/documentation/features/customization.md): Customize your Auk experience.
- [Environments](https://auk.mamahuhu.dev/documentation/features/environments.md): Manage environment variables for different contexts and configurations
- [History](https://auk.mamahuhu.dev/documentation/features/history.md): Store and access your previous requests and responses.
- [Importer](https://auk.mamahuhu.dev/documentation/features/importer.md): Migrate your data from other tools into Auk.
- [Interceptor](https://auk.mamahuhu.dev/documentation/features/interceptor.md): Intercept and modify requests and responses.
- [Runner](https://auk.mamahuhu.dev/documentation/features/runner.md): Iterate and execute your requests in a collection.
- [Scripts](https://auk.mamahuhu.dev/documentation/features/scripts.md): Write pre-request scripts and build tests.
- [Shortcuts](https://auk.mamahuhu.dev/documentation/features/shortcuts.md): Keyboard shortcuts for Auk.
- [Code Snippets](https://auk.mamahuhu.dev/documentation/features/snippets.md): Generate code snippets for your API in a variety of languages and frameworks.
- [Variables](https://auk.mamahuhu.dev/documentation/features/variables.md): Dynamic placeholders for your API interactions.
- [Create Your First Workspace](https://auk.mamahuhu.dev/documentation/getting-started/first-workspace.md): Quickly create and configure your first workspace
- [Setup Git Sync](https://auk.mamahuhu.dev/documentation/getting-started/git-setup.md): Configure Git synchronization for team collaboration and backup
- [Running a simple query](https://auk.mamahuhu.dev/documentation/getting-started/graphql/creating-a-query.md): Learn how to run a simple query using Auk.
- [Using variables in a GraphQL query](https://auk.mamahuhu.dev/documentation/getting-started/graphql/using-variables.md): Learn how to use variables in a GraphQL query.
- [Install Auk](https://auk.mamahuhu.dev/documentation/getting-started/installation.md): Download and install Auk desktop app
- [Introduction to Auk](https://auk.mamahuhu.dev/documentation/getting-started/introduction.md): Local-first API development ecosystem
- [Quick Start Guide](https://auk.mamahuhu.dev/documentation/getting-started/quick-start.md): Get up and running with Auk in 5 minutes
- [MQTT](https://auk.mamahuhu.dev/documentation/getting-started/realtime/mqtt.md): MQTT is a lightweight publish-subscribe messaging protocol.
- [Socket.IO](https://auk.mamahuhu.dev/documentation/getting-started/realtime/socket-io.md): Learn how to use the Socket.IO testing tool in Auk.
- [Server-Sent Events](https://auk.mamahuhu.dev/documentation/getting-started/realtime/sse.md): Server-Sent Events (SSE) is a server push technology enabling a client to receive automatic updates from a server via HTTP connection.
- [Websocket](https://auk.mamahuhu.dev/documentation/getting-started/realtime/websocket.md): Connect to a WebSocket and send messages.
- [Using auth tokens](https://auk.mamahuhu.dev/documentation/getting-started/rest/auth-tokens.md): Learn how to use authentication tokens in Auk.
- [Creating a request](https://auk.mamahuhu.dev/documentation/getting-started/rest/creating-a-request.md): Learn how to create a request in Auk.
- [Environment variables](https://auk.mamahuhu.dev/documentation/getting-started/rest/environment-variables.md): Learn how to use environment variables in your requests and scripts.
- [Organizing requests](https://auk.mamahuhu.dev/documentation/getting-started/rest/organizing-requests.md): Organize your requests categorically for future reference or collaboration with your team using collections.
- [Pre-request scripts](https://auk.mamahuhu.dev/documentation/getting-started/rest/pre-request-scripts.md): Learn how to use pre-request scripts in Auk.
- [Request headers](https://auk.mamahuhu.dev/documentation/getting-started/rest/request-headers.md): Request Headers allow you to pass additional information with requests, helping to control how the server responds.
- [Request parameters](https://auk.mamahuhu.dev/documentation/getting-started/rest/request-parameters.md): Request parameters help you to filter and request specific data from an API endpoint.
- [Response handling](https://auk.mamahuhu.dev/documentation/getting-started/rest/response-handling.md): View, interpret and manage responses from your API requests.
- [Tests](https://auk.mamahuhu.dev/documentation/getting-started/rest/tests.md): Tests are executed after a response is received from the server. You can add multiple tests to a request. You can add tests to both requests saved and not saved in a collection.
- [Uploading data](https://auk.mamahuhu.dev/documentation/getting-started/rest/uploading-data.md): Learn how to upload data to an API using Auk.
- [Authentication](https://auk.mamahuhu.dev/documentation/git-sync/authentication.md): Configure authentication for Git synchronization
- [Auto Sync](https://auk.mamahuhu.dev/documentation/git-sync/auto-sync.md): Configure automatic Git synchronization for seamless collaboration
- [Conflict Resolution](https://auk.mamahuhu.dev/documentation/git-sync/conflict-resolution.md): Handle and resolve Git merge conflicts effectively
- [Git Sync Overview](https://auk.mamahuhu.dev/documentation/git-sync/introduction.md): Version control and collaboration with Git
- [Git Sync Setup](https://auk.mamahuhu.dev/documentation/git-sync/setup.md): Configure Git synchronization for team collaboration
- [Git Sync Troubleshooting](https://auk.mamahuhu.dev/documentation/git-sync/troubleshooting.md): Common Git synchronization issues and solutions
- [GraphQL](https://auk.mamahuhu.dev/documentation/protocols/graphql.md): GraphQL is a query language for APIs that queries the server and provides the client only the data that is requested by the client. GraphQL enables you to fetch data from multiple APIs in a single query thus helping you build better-performing applications.
- [Realtime](https://auk.mamahuhu.dev/documentation/protocols/realtime.md): Auk's Realtime API platform helps you test your real-time APIs easily.
- [RESTful](https://auk.mamahuhu.dev/documentation/protocols/rest.md): RESTful API testing with Auk.
- [Backup & Restore](https://auk.mamahuhu.dev/documentation/storage/backup-restore.md): Strategies for backing up and restoring your Auk data
- [Data Location](https://auk.mamahuhu.dev/documentation/storage/data-location.md): Find and manage your Auk workspace data
- [File System Storage](https://auk.mamahuhu.dev/documentation/storage/file-system.md): Understanding Auk's local file system storage
- [Creating a Workspace](https://auk.mamahuhu.dev/documentation/workspace/creating.md): Step-by-step guide to creating and configuring your first workspace
- [Workspace Management](https://auk.mamahuhu.dev/documentation/workspace/introduction.md): Organize your API projects with workspaces
- [Workspace Settings](https://auk.mamahuhu.dev/documentation/workspace/settings.md): Configure and customize your workspace preferences
- [Switching Workspaces](https://auk.mamahuhu.dev/documentation/workspace/switching.md): Efficiently manage and switch between multiple workspaces
- [Improving your API workflow](https://auk.mamahuhu.dev/guides/articles/improving-your-api-workflow.md): Learn how to improve your API workflow with Auk.
- [RESTful API testing with Auk](https://auk.mamahuhu.dev/guides/articles/restful-api-testing-with-auk.md): Learn how to use Auk to test your RESTful APIs.
- [Understanding the GraphQL Schema on Auk](https://auk.mamahuhu.dev/guides/articles/understanding-graphql.md): Learn how to use the GraphQL schema on Auk.
- [Git Collaboration](https://auk.mamahuhu.dev/guides/git-collaboration.md): Best practices for team collaboration using Git
- [Local-First Workflow Best Practices](https://auk.mamahuhu.dev/guides/local-first-workflow.md): Master the local-first approach to API development with Auk
- [Migrate from Auk Cloud](https://auk.mamahuhu.dev/guides/migration/from-auk.md): Step-by-step guide to migrate from Auk Cloud to Auk
- [Migrate from Insomnia](https://auk.mamahuhu.dev/guides/migration/from-insomnia.md): Step-by-step guide to migrate from Insomnia to Auk
- [Migrate from Postman](https://auk.mamahuhu.dev/guides/migration/from-postman.md): Step-by-step guide to migrate from Postman to Auk
- [Offline Usage](https://auk.mamahuhu.dev/guides/offline-usage.md): Master working with Auk completely offline
- [Workspace Organization](https://auk.mamahuhu.dev/guides/workspace-organization.md): Strategies for organizing your Auk workspaces effectively
- [Code of conduct](https://auk.mamahuhu.dev/support/code-of-conduct.md): Code of conduct for Auk.
- [Contact](https://auk.mamahuhu.dev/support/getting-started/contact.md): Contact us to get technical support, report a bug, suggest a new feature or improvement, or join our community.
- [Frequently Asked Questions](https://auk.mamahuhu.dev/support/getting-started/faq.md): These are the most frequently asked questions about Auk.
- [License](https://auk.mamahuhu.dev/support/license.md): Auk is licensed under MIT License.
- [Security policy](https://auk.mamahuhu.dev/support/security-policy.md): Security procedures and general policies for Auk.

## OpenAPI Specs

- [openapi](https://auk.mamahuhu.dev/api-reference/openapi.json)

## Optional

- [Download](https://auk.mamahuhu.io/download)
- [GitHub](https://github.com/mamahuhu-io/auk)