Home

ApiArk Wiki

The API platform that respects your privacy, your RAM, and your Git workflow.

Welcome to the official ApiArk documentation wiki. Here you'll find everything you need to get started, master advanced features, and contribute to the project.

---

Quick Navigation

Section	Description
Getting Started	Install, launch, and send your first request in under 2 minutes
Installation Guide	Platform-specific installation and building from source
Collections & YAML Format	How ApiArk stores your API requests as plain YAML files
Environment Variables	Manage variables, secrets, and dynamic values
Protocol Support	REST, GraphQL, gRPC, WebSocket, SSE, MQTT
Authentication	Bearer, OAuth 2.0, AWS Sig v4, Digest, NTLM, JWT
Scripting Engine	Pre/post scripts with the ark API
Testing & Assertions	Declarative YAML assertions and JavaScript tests
Collection Runner	Run collections with data-driven testing
Mock Servers	Local mock servers with Faker.js and latency simulation
Scheduled Testing	Cron-based monitors with notifications
CLI Reference	apiark command-line tool for CI/CD
Import & Export	Migrate from Postman, Bruno, Insomnia, and more
Keyboard Shortcuts	Full shortcut reference
Configuration & Settings	Proxy, SSL, certificates, themes, and preferences
Troubleshooting & FAQ	Common issues and solutions
Contributing	Development setup, code standards, and PR process
Comparison with Postman	Why developers are switching

---

Why ApiArk?

	Postman	Bruno	Hoppscotch	ApiArk
Framework	Electron	Electron	Tauri	Tauri v2
RAM Usage	300-800 MB	150-300 MB	50-80 MB	~60 MB
Startup	10-30s	3-8s	<2s	<2s
Login Required	Yes	No	Optional	No
Data Storage	Cloud	Filesystem	IndexedDB	YAML + Git
Protocols	REST, GraphQL, gRPC, WS	REST, GraphQL	REST, GraphQL, WS	REST, GraphQL, gRPC, WS, SSE, MQTT
Mock Servers	Cloud only	No	No	Local
Open Source	No	MIT	MIT	MIT

---

Core Principles

1. Local-First, Always — Your data stays on your machine. No accounts, no cloud sync, no telemetry.
2. Native Speed — Tauri v2 = Rust backend + native OS webview. ~60 MB RAM, <2s startup.
3. Standards Over Proprietary — YAML for storage, OpenAPI for design, Git for collaboration.
4. Progressive Complexity — Simple things instant, complex things possible.
5. Developer-Native UX — IDE-like feel. Keyboard-first, command palette, split panes.
6. Open Core — MIT-licensed core. Free forever for individual developers.

---

Get Help

• GitHub Issues — Bug reports and feature requests
• GitHub Discussions — Q&A and ideas
• Discord — Real-time community chat
• Twitter/X — Updates and announcements

---

ApiArk is MIT-licensed open source software. Built with Tauri v2, React, TypeScript, and Rust.