> For the complete documentation index, see [llms.txt](https://docs.yo.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yo.xyz/integrations/integration-guides/sdk/getting-started/installation.md).

# Installation

## Core Package

The core SDK works in any JavaScript environment — Node.js, browsers, serverless, or scripts.

```bash
pnpm add @yo-protocol/core viem
```

```bash
npm install @yo-protocol/core viem
```

```bash
yarn add @yo-protocol/core viem
```

| Dependency          | Purpose                                                          |
| ------------------- | ---------------------------------------------------------------- |
| `@yo-protocol/core` | Client, vault reads, actions, API client, constants              |
| `viem`              | Low-level EVM interaction (contract calls, encoding, transports) |

{% hint style="info" %}
**Zod included**

`@yo-protocol/core` bundles `zod` internally for runtime validation of API responses. You do not need to install it separately.
{% endhint %}

## React Package

For React apps using wagmi and TanStack Query:

```bash
pnpm add @yo-protocol/react @yo-protocol/core viem wagmi @tanstack/react-query
```

```bash
npm install @yo-protocol/react @yo-protocol/core viem wagmi @tanstack/react-query
```

```bash
yarn add @yo-protocol/react @yo-protocol/core viem wagmi @tanstack/react-query
```

### Peer Dependencies

| Package                 | Minimum version |
| ----------------------- | --------------- |
| `react`                 | 18.0.0          |
| `react-dom`             | 18.0.0          |
| `wagmi`                 | 2.0.0           |
| `viem`                  | 2.0.0           |
| `@tanstack/react-query` | 5.0.0           |

## TypeScript

Both packages ship with full TypeScript declarations. TypeScript 5.0+ is recommended but not required — the SDK works fine in plain JavaScript.

## Verify Installation

```ts
import { createYoClient } from '@yo-protocol/core'

const client = createYoClient({ chainId: 8453 })
const vaults = client.getVaults()

console.log(`Found ${vaults.length} vaults on Base`)
```

## Next Steps

* [Quick Start](broken://pages/cc26cc2ce5c3e110ce4caca32b7a263168920bd6) — Build your first integration
* [@yo-protocol/core Overview](file:///3007190/core/overview.md) — Core SDK reference
* [@yo-protocol/react Overview](file:///3007190/react/overview.md) — React hooks reference


---

# 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.yo.xyz/integrations/integration-guides/sdk/getting-started/installation.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.