> For the complete documentation index, see [llms.txt](https://docs.orchard.airoverflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.orchard.airoverflow.com/readme.md).

# Introduction

Drive iOS and Android sandboxes from Python, TypeScript or JavaScript.

**Orchard** gives you programmatic, on-demand iOS and Android devices ("sandboxes") with full control: boot and stop them, install apps, push and pull files, take snapshots, and stream their screen, logs and shell live. These SDKs wrap Orchard's REST API and its live WebSocket channels so you can build on it from your own code and CI.

Two first-class clients, with a deliberately **parallel API** so the two read the same:

|                             | Package        | Install                    |
| --------------------------- | -------------- | -------------------------- |
| **Python**                  | `orchard-sdk`  | `pip install orchard-sdk`  |
| **TypeScript / JavaScript** | `@orchard/sdk` | `npm install @orchard/sdk` |

## What you can do

* **Sandboxes** — list, create, start, stop, edit, tag, terminate.
* **Snapshots & templates** — capture a device state and restore or clone it.
* **Files & apps** — push/pull files, install/uninstall/pull APKs & IPAs.
* **Live channels** — stream logs, open an interactive shell, read raw screen frames, bridge adb, or watch captured HTTP(S) flows.
* **Access** — mint **fine-grained API keys** scoped to specific sandboxes (or a tag) and a reduced capability set; manage teams, members and workspaces.
* **Remote cloud sandboxes** — drive e2b / daytona / modal-backed devices.

## 30-second taste

{% tabs %}
{% tab title="Python" %}

```python
from orchard_sdk import Orchard

orchard = Orchard.from_env()
sb = orchard.sandbox("my-pixel")      # by uuid / prefix / name / tag
sb.tag("payments", "#22c55e")
with sb.logs() as stream:
    for line in stream:
        print(line)
```

{% endtab %}

{% tab title="TypeScript" %}

```ts
import { Orchard } from "@orchard/sdk";

const orchard = Orchard.fromEnv();
const sb = await orchard.sandbox("my-pixel");
await sb.tag("payments", "#22c55e");
for await (const line of sb.logs()) console.log(line);
```

{% endtab %}
{% endtabs %}

Head to [Installation](/install.md) and then the [Python](/quickstart/python.md) or [TypeScript](/quickstart/typescript.md) quickstart.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.orchard.airoverflow.com/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
