Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agtos.ai/llms.txt

Use this file to discover all available pages before exploring further.

The easiest way to run agtOS. The desktop app bundles everything — no Node.js, no terminal, no manual configuration. Download from GitHub Releases:
PlatformFormatArchitecture
macOS.dmgApple Silicon (arm64) + Intel (x86_64)
Windows.msix86_64
Linux.AppImage, .debx86_64
After installation, launch the app and follow the onboarding wizard. It guides you through API key setup, voice model downloads, and microphone configuration — all from a visual interface.
The desktop app includes a bundled Node.js backend compiled as a Single Executable Application. You don’t need to install Node.js, Redis, or any other dependency separately.

​
What’s included

  • System tray with health indicator (green/yellow/red)
  • Global push-to-talk hotkey (default: Alt+Space) — works from any application
  • Auto-start on system login (optional)
  • Auto-update from GitHub releases
  • Native notifications for health changes and task completions
See Desktop App for full details.

​
CLI (for developers)

For developers who want source access, customization, and terminal-based workflows.

​
Requirements

ComponentVersionRequiredWhat it enables
Node.js22+YesCore runtime
DockerLatestNoConvenient Redis management
Redis7.2+ with RediSearchNoMemory, scheduling, devices, preferences
OllamaLatestNoLocal AI routing, embeddings, intent classification

​
Install methods

git clone https://github.com/agtos-ai/agtos.git
cd agtos
npm install
npx agtos setup    # Interactive configuration wizard
npx agtos start    # Start the server

​
Verify installation

npx agtos doctor
Runs 12 diagnostic checks (Node.js, Docker, Redis, Ollama, speech models, credentials, network, ports) and reports pass/warn/fail with remediation hints.

​
Ports

PortServiceProtocol
3000Voice pipelineWebSocket (/audio), WebRTC signaling (/webrtc)
4100MCP serverHTTP (POST /mcp)
4102Health, REST API, dashboard, Prometheus metricsHTTP
All configurable via VOICE_PORT, MCP_PORT, and HEALTH_PORT.

​
What’s next?

Quickstart

Step-by-step guide from install to first conversation.

Use Cases

See what you can build with agtOS.

Authentication

Set up Anthropic or OpenAI API keys.

FAQ

Common questions about setup, voice, and privacy.