orgo/README.md

Computers for AI agents

# Orgo SDK

Desktop infrastructure for AI agents.

## Install

```bash
npm install orgo
# or
yarn add orgo
# or
pnpm add orgo
```

## Usage

```typescript
import { Computer } from 'orgo';

// Create computer
const computer = await Computer.create();

// Control
await computer.leftClick(100, 200);
await computer.type("Hello world");
await computer.key("Enter");
await computer.screenshot(); // Returns Buffer

// Execute code
await computer.exec("import pyautogui; pyautogui.click(512, 384)");

// Cleanup
await computer.shutdown();
```

### Configuration

```typescript
const computer = await Computer.create({
  apiKey: 'your-api-key', // or set ORGO_API_KEY env var
  projectId: 'existing-project-id', // optional
  config: { /* custom config */ }, // optional
  baseApiUrl: 'https://custom-api.com' // optional
});
```

### Available Methods

#### Navigation
- `leftClick(x, y)` - Left mouse click
- `rightClick(x, y)` - Right mouse click  
- `doubleClick(x, y)` - Double click
- `scroll(direction, amount)` - Scroll in a direction

#### Input
- `type(text)` - Type text
- `key(key)` - Press key or key combination

#### View
- `screenshot()` - Get screenshot as Buffer
- `screenshotBase64()` - Get screenshot as base64 string

#### Execution
- `exec(code, timeout?)` - Execute Python code
- `bash(command)` - Execute bash command
- `wait(seconds)` - Wait for specified seconds

#### AI Control
- `prompt(options)` - Control computer with Claude 4

#### Lifecycle
- `status()` - Get computer status
- `restart()` - Restart the computer
- `shutdown()` - Terminate the computer

Full documentation: [docs.orgo.ai](https://docs.orgo.ai)

## TypeScript Support

This package includes TypeScript declarations. All types are exported and available:

```typescript
import type { ComputerConfig, ComputerStatus, PromptOptions } from 'orgo';
```

## License

MIT