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

# Installation

## Python

Requires Python ≥ 3.10.

```bash
pip install orchard-sdk
```

From a checkout of the Orchard repo:

```bash
pip install -e sdk/python
```

The only runtime dependencies are [`httpx`](https://www.python-httpx.org/) (REST) and [`websockets`](https://websockets.readthedocs.io/) (live channels).

## TypeScript / JavaScript

Requires Node ≥ 18 (or any modern browser). The package ships ESM, CommonJS and type declarations, so `import` and `require` both work.

```bash
npm install @orchard/sdk
```

On **Node < 21** there is no global `WebSocket`, so install the optional peer dependency to use the live channels:

```bash
npm install ws
```

Node ≥ 21 and browsers have `WebSocket` built in and need nothing extra.

From a checkout of the Orchard repo:

```bash
npm --prefix sdk/typescript install
npm --prefix sdk/typescript run build
```

## Next

Set your credentials (see [Authentication](/auth.md)), then try a [quickstart](/quickstart/python.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/install.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.