Docs Getting Started Introduction

Introduction

Welcome to VortexHQ — your all-in-one developer command center. This guide will help you get started.

What is VortexHQ?

VortexHQ is a cross-platform desktop application that combines six essential developer tools into a single, beautifully designed interface:

  • Email — Local SMTP server with inbox, HTML preview, spam analysis, bounce/DKIM/SPF detection, and AI summaries
  • API Client — Full-featured HTTP client with collections, environments, scripting, cloud sync, and cluster overview dashboards
  • SSH Terminal — Multi-tab SSH with xterm.js, snippets, SFTP integration, and AI-powered command generation
  • SQL Client — MySQL & PostgreSQL client with query editor, table management, SSH tunnels, and AI-powered SQL generation
  • FTP / SFTP — File browser with drag-and-drop uploads, permissions management, file sync, and multiple protocol support
  • AI Engine — 7 AI providers (Vortex, OpenAI, Anthropic, DeepSeek, Groq, Ollama, Custom) integrated across every module

System Requirements

PlatformRequirement
macOSmacOS 12 (Monterey) or later — Intel & Apple Silicon (universal binary)
WindowsWindows 10 or later — x64
LinuxAppImage or .deb package

Installation

  1. Download the latest version from the Downloads section
  2. Open the .dmg (macOS), run the .exe installer (Windows), or launch the .AppImage (Linux)
  3. Launch VortexHQ — the setup wizard will generate SSL certificates for your local SMTP server and configure system trust
  4. Sign in or create a free account to unlock cloud features

First Launch

On first launch, VortexHQ opens to the Home screen — your AI command center with quick actions and usage overview. Switch between modules using the sidebar icons:

ShortcutModule
Cmd+1Email
Cmd+2SSH Terminal
Cmd+3FTP / SFTP
Cmd+4API Client
Cmd+5SQL Client

At the bottom of the sidebar you'll find Notifications, Account, and Settings (Cmd+,). Sidebar tabs can be hidden or reordered from Settings → General.

Deep Links

VortexHQ registers the vortexhq:// protocol, allowing you to trigger actions from your browser or other apps — such as social login callbacks or shared cluster links.

Auto-Updates

VortexHQ checks for updates automatically. When a new version is available, you'll see a notification in Settings → General with options to download and install. Updates install automatically when you quit the app.

Last updated 12 hours ago