openai-cua-sample-app  by openai

Sample app for Computer Using Agent (CUA) development via OpenAI API

Created 6 months ago
1,119 stars

Top 34.3% on SourcePulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

This repository provides a sample application to learn and build Computer Using Agents (CUAs) with the OpenAI API. It targets developers and researchers looking to integrate AI agents with various computer environments, offering a flexible framework for executing AI-recommended actions.

How It Works

The core of the system involves an agent loop that receives screenshots of a computer interface and recommends actions (e.g., clicks, typing) via the OpenAI API. These actions are then executed in a chosen "computer environment" (local browser, Docker, remote browser), and the resulting screenshots are fed back to the agent. This iterative process allows the AI to interact with and navigate digital environments.

Quick Start & Requirements

  • Install dependencies: pip install -r requirements.txt
  • Run CLI: python cli.py --computer local-playwright
  • Requires Python 3.x, Playwright SDK (install via prompt on first run).
  • Official Docs: Computer use guide

Highlighted Details

  • Supports multiple computer environments: LocalPlaywright, Docker, Browserbase, Scrapybara.
  • Provides abstractions for Computer (action execution) and Agent (interaction loop).
  • CLI tool for easy experimentation with different environments and inputs.
  • Example implementations for custom function routing to the computer environment.

Maintenance & Community

  • OpenAI maintained.
  • Contribution guide available for adding new computer environments.

Licensing & Compatibility

  • License: Not explicitly stated in the README.
  • Compatibility: Designed for use with OpenAI API; commercial use implications depend on OpenAI's API terms.

Limitations & Caveats

The Computer use feature is in preview, with a caution against using it in authenticated or high-stakes environments due to potential exploits and mistakes. The Docker environment setup requires building and running a container, which can take time on the first run.

Health Check
Last Commit

4 months ago

Responsiveness

Inactive

Pull Requests (30d)
1
Issues (30d)
2
Star History
44 stars in the last 30 days

Explore Similar Projects

Starred by Yiran Wu Yiran Wu(Coauthor of AutoGen), Chip Huyen Chip Huyen(Author of "AI Engineering", "Designing Machine Learning Systems"), and
3 more.

OS-Copilot by OS-Copilot

0.1%
2k
OS agent for automating daily tasks
Created 1 year ago
Updated 1 year ago
Feedback? Help us improve.