Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Installation Guide

Anes Berbic edited this page Mar 13, 2026 · 1 revision

Installation Guide


System Requirements

Requirement Minimum
OS Windows 10+, macOS 11+, Ubuntu 20.04+ / Fedora 36+
RAM 4 GB (ApiArk uses ~60 MB)
Disk 100 MB free space
Display 1280x720 minimum

Download

Get the latest release from GitHub Releases.

Windows

File Description
ApiArk_x64-setup.exe NSIS installer (recommended)
ApiArk_x64_en-US.msi MSI installer
  1. Download the .exe or .msi installer
  2. Run the installer
  3. ApiArk appears in your Start Menu

SmartScreen Warning: If Windows shows a SmartScreen warning, click "More info" → "Run anyway". This happens because we're a new application — code signing is in progress.

macOS

File Description
ApiArk_aarch64.dmg Apple Silicon (M1/M2/M3/M4)
ApiArk_x64.dmg Intel Macs
  1. Download the correct .dmg for your Mac
  2. Open the .dmg and drag ApiArk to Applications
  3. On first launch: Right-click → Open (bypasses Gatekeeper for unsigned apps)

Check your chip: Apple menu → About This Mac → Chip. If it says "Apple M1/M2/M3/M4", use the aarch64 version.

Linux

File Description
ApiArk_amd64.AppImage Universal (any distro)
ApiArk_amd64.deb Debian/Ubuntu
api-ark.rpm Fedora/RHEL

AppImage:

chmod +x ApiArk_*.AppImage
./ApiArk_*.AppImage

Debian/Ubuntu:

sudo dpkg -i ApiArk_*.deb

Fedora/RHEL:

sudo rpm -i api-ark-*.rpm

Auto-Updates

ApiArk includes a built-in auto-updater. When a new version is available, you'll see a non-blocking banner:

"ApiArk v0.X.X is available. [Update Now] [Release Notes] [Later]"

Updates are downloaded in the background and applied on restart. You're never forced to update.

Update Channels

Channel Description
Stable Default. Tested releases every 2-4 weeks
Beta Weekly. Feature-complete, may have bugs
Nightly Daily. Bleeding edge, may break

Change your update channel in Settings → Updates.


Build from Source

Prerequisites

Tool Version
Node.js 22+
pnpm 10+
Rust Latest stable
Tauri CLI 2.x

Linux Dependencies

# Ubuntu/Debian
sudo apt install -y \
 libwebkit2gtk-4.1-dev \
 libappindicator3-dev \
 librsvg2-dev \
 patchelf \
 libssl-dev
# Fedora
sudo dnf install -y \
 webkit2gtk4.1-devel \
 libappindicator-gtk3-devel \
 librsvg2-devel \
 patchelf \
 openssl-devel

Build Steps

# Clone the repo
git clone https://github.com/berbicanes/apiark.git
cd apiark
# Install dependencies
pnpm install
# Development mode (hot-reload)
pnpm dev
# Production build
pnpm build

The built app will be in apps/desktop/src-tauri/target/release/bundle/.

CLI Build

cd apps/cli
cargo build --release
# Binary at: target/release/apiark

Verify Installation

  1. Launch ApiArk
  2. Press Ctrl+K to open the Command Palette
  3. Type "version" — you should see the current version
  4. Send a test request to https://httpbin.org/get

If everything works, you're ready to go! Head to Getting Started for a guided tour.


Uninstall

Your data is safe. Uninstalling ApiArk does not delete your collections (they're YAML files in your chosen directories).

To fully remove ApiArk and its app data:

# Linux/macOS — remove app data
rm -rf ~/.apiark/
# Collections are wherever you saved them — keep or delete as needed

Windows: Uninstall from Settings → Apps. App data is in %APPDATA%/dev.apiark.app/ — delete if desired.

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /