# AskUI Agent OS

Platform-specific binaries for the **AskUI Remote Device Controller**, shipped as a Python package. Use it with the [AskUI Python SDK](https://github.com/askui/python-sdk) when you need local device control—see the [Setup Guide](https://docs.askui.com) in the official docs.

## Requirements

- **Python:** 3.8+
- **Platforms:** Windows, Linux, macOS
- **Windows only:** [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) (minimum version 14.34.31938). The package checks this automatically when you use the API.

## Installation

```bash
pip install askui-agent-os
```

## Usage

### Command line

Get the path to the Remote Device Controller binary:

```bash
askui-agent-os get-binary-path
```

### Python API

The package exposes a single class, **`AgentOS`**, with static methods. On import, `AgentOS.setup()` runs and makes the controller binary executable (no-op on Windows). Prerequisites (e.g. Windows VC++ runtime) are checked when you call `bin_path()` or `controller_path()`.

```python
from askui_agent_os import AgentOS

# Directory containing platform binaries
bin_dir = AgentOS.bin_path()

# Full path to the controller executable (use this with the AskUI SDK)
path = AgentOS.controller_path()

# Optional: require Windows VC++ runtime (raises RuntimeError if missing on Windows)
AgentOS.require_vc_redistributable()
```

| Method | Description |
|--------|-------------|
| `AgentOS.bin_path()` | Path to the package `bin` directory. |
| `AgentOS.controller_path()` | Full path to the controller executable. |
| `AgentOS.require_vc_redistributable()` | No-op on non-Windows; on Windows, raises if the required VC++ runtime is missing. |

## CI/CD and automated pipelines

**This package is for local and desktop use only.** It is **not** suitable for use in CI/CD or other headless/automated pipelines. For CI/CD you need the dedicated AskUI service. To request access, contact **support@askui.com**.

## License

Use of AskUI Agent OS is subject to the AskUI Agent OS Terms of Service. Non-commercial use is free; commercial use requires a separate Commercial Licence from AskUI.

## Links

- [Homepage](https://www.askui.com/)
- [Python SDK](https://github.com/askui/python-sdk)
- [Documentation](https://docs.askui.com)
- [Support](mailto:support@askui.com)
