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

# 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