> 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/cli/readme.md).

# Introduction

Drive Orchard sandboxes from your terminal.

`orchard` is a single command-line tool for working with Orchard sandboxes: list/create/start/stop/edit them, manage snapshots, templates, teams and API keys, and, the part a browser can't do, bridge **adb**, launch **scrcpy** or a **VNC** viewer, open an interactive **shell**, tail **logs**, push/pull **files**, and install **apps**, all against a remote device.

It's the quickest way to script Orchard or poke at a device by hand; for embedding Orchard in your own app, use the [SDKs](https://github.com/TheFlash2k/orchard/tree/main/sdk/README.md) instead.

## At a glance

```bash
orchard sandbox list
orchard tag set my-pixel payments --color "#22c55e"
orchard adb my-pixel                      # then: adb connect 127.0.0.1:<port>
orchard scrcpy my-pixel                   # Android live screen
orchard vnc frida2                        # iOS-VM live screen
orchard shell my-pixel                    # interactive device shell
orchard logs my-pixel -f                  # follow logs
orchard app install my-pixel app.apk
orchard file pull my-pixel /sdcard/x.pdf ./x.pdf
orchard key add ci --sandbox my-pixel --cap logs --cap files --expires 30
```

Every command that targets a device takes a **selector**, a uuid, a uuid prefix, an exact name, or a tag (see [sandbox](/cli/managing-sandboxes/sandbox.md)). Add `--json` to any command for machine-readable output.

Start with [Installation](/cli/install.md) and [Authentication](/cli/auth.md).


---

# 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/cli/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.