​
Requirements

Before getting started, make sure you have the following installed:

​
Docker

Docker is required for all cuse setups. Make sure you have Docker installed and running on your machine. You can download Docker from the official Docker website.

​
Anthropic API Key

If you’re following the Quick Start Example, you’ll need an Anthropic API key.
  1. Sign up at Anthropic
  2. Create an API key from your dashboard
  3. Save it to your environment:
# In your terminal
export ANTHROPIC_API_KEY=your-api-key

# Or create a .env file in the example directory
echo "ANTHROPIC_API_KEY=your-api-key" > .env

​
Quick Start Example

Learn how to get started with our example repository.

​
1. Clone the repository

git clone https://github.com/cuse-dev/cuse-quickstart
cd cuse-quickstart

​
2. Start the computer

npx @cusedev/cli start

​
3. Run the example

npm install
npm run dev

​
Add to Existing Project

Learn how to integrate cuse into your existing project.

​
1. Install and initialize

npm install @cusedev/core
npx @cusedev/cli init
npx @cusedev/cli new

​
2. Start the computer

npx @cusedev/cli start

​
3. Implement cuse

Create the computer instance: 
const computer = new Computer({
  config: {
    baseUrl: 'http://localhost:4242/your-computer-name',
  },
});
Interact with the computer: 
const base64 = await computer.system.display.getScreenshot();

​
Next Steps

CLI Reference

Learn how to use the cuse CLI to manage your computers

API Reference

Learn how to use the REST API to interact with your computers