# Installation

The YieldFi SDK is available as an npm package and can be installed in your project using npm, yarn, or pnpm.

### Prerequisites

* **Node.js**: Version 18.0.0 or higher
* **Package Manager**: npm, yarn, or pnpm
* **TypeScript**: Recommended (SDK is written in TypeScript)

### Install via npm

```bash
npm install yieldfi-sdk
```

### Install via yarn

```bash
yarn add yieldfi-sdk
```

### Install via pnpm

```bash
pnpm add yieldfi-sdk
```

### Verify Installation

After installation, verify that the SDK is properly installed:

```typescript
import { YieldFiSDK } from "yieldfi-sdk";

console.log(YieldFiSDK.getVersion()); // "0.3.0"
```

### TypeScript Support

The SDK is written in TypeScript and includes full type definitions. No additional `@types` packages are required.

If you're using TypeScript, ensure your `tsconfig.json` includes:

```json
{
  "compilerOptions": {
    "module": "ESNext",
    "target": "ES2020",
    "lib": ["ES2020"],
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}
```

### Next Steps

* Quick Start Guide - Get up and running in minutes
* Configuration - Learn about SDK configuration options


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.yield.fi/earn-with-yieldfi/integration-sdk/getting-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.