Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.askui.com/llms.txt

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

Install AgentOS locally in standalone mode. This is the fastest way to start building agents.
AgentOS is proprietary software, free for non-commercial use. For commercial deployments, a license is required. See pricing for details.

Prerequisites

  • Python 3.10 or newer
  • Windows, macOS, or Linux — see System Requirements for supported versions.
  • macOS only: You must grant Accessibility and Screen Recording permissions to your terminal or IDE. Go to System Settings → Privacy & Security and enable both permissions for the application running AgentOS.

Install

AgentOS is available on PyPI and included as a dependency of the AskUI SDK. Most users already have it:
pip install askui-agent-os
If you installed the AskUI SDK, AgentOS is already available. You only need to install it separately if you want a specific version.

What’s Next?

Getting Started

Build your first agent with the AskUI Python SDK.

Runtime Modes

Understand standalone vs OS service mode.

Control Modes

Host Mode vs Companion Mode — how AgentOS connects to targets.

Deploy as OS Service

Set up AgentOS as a Windows service for CI/CD and enterprise.