Skip to content
/ cuse Public
forked from cuse-dev/cuse

Framework for implementing computer use for AI agents

License

Notifications You must be signed in to change notification settings

tokwalabs/cuse

 
 

Repository files navigation

cuse

An open-source framework for building AI agents that can interact with computers

Features

  • Computer Control: Display, mouse, and keyboard interaction
  • Authentication: Authenticate with credentials
  • File Operations: View, create, and edit files
  • Shell Access: Execute commands and manage processes
  • App Framework: Build custom applications
  • Linux Support: Run via Docker containers

Demo

Task: Check gmail inbox and send summary to {email}.

cuse.demo.mp4

Quickstart

Install dependencies:

npm install @cusedev/core

Initialize and create a computer:

npx @cusedev/cli init

Create a Computer instance

import { Computer } from '@cusedev/core';

const computer = new Computer();

Interact with the computer:

// Take a screenshot
const screenshot = await computer.system.display.getScreenshot();

// Type some text
await computer.system.keyboard.type({ text: 'Hello, World!' });

// Execute a command
const output = await computer.system.bash.execute({ command: 'ls -la' });

Documentation

Visit our documentation to learn more about:

  • Getting started with the example project
  • Adding cuse to your existing project
  • Core concepts and API reference
  • CLI commands and usage

Roadmap

  • Support for other platforms
  • Deployment
  • Stateful Machines
  • Reusable Workflows

Contributing

Contributions are welcome! Please check out our GitHub repository.

License

MIT License — see LICENSE file

Get in Touch

Star History

Star History Chart

About

Framework for implementing computer use for AI agents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 58.4%
  • Python 30.2%
  • MDX 6.7%
  • Shell 2.1%
  • Dockerfile 1.1%
  • JavaScript 0.8%
  • CSS 0.7%