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

# Installation

## Requirements

* **Node.js**: 16+ or modern browser
* **TypeScript**: 5.0+ (for TypeScript users)

## NPM Installation

Install the DotPassport SDK via npm:

```bash
npm install @dotpassport/sdk
```

## Yarn Installation

```bash
yarn add @dotpassport/sdk
```

## PNPM Installation

```bash
pnpm add @dotpassport/sdk
```

## CDN Installation

For browser usage without a build step:

```html
<script type="module">
  import { DotPassportClient, createWidget } from 'https://cdn.jsdelivr.net/npm/@dotpassport/sdk/+esm';

  // Use the SDK
  const client = new DotPassportClient({ apiKey: 'your-key' });
</script>
```

## Verify Installation

After installation, verify it works:

```typescript
import { DotPassportClient } from '@dotpassport/sdk';

const client = new DotPassportClient({
  apiKey: 'test_key'
});

console.log('SDK installed successfully!');
```

## Next Steps

* [Quick Start Guide](/getting-started/quick-start.md) - Get started in 5 minutes
* [Authentication](/getting-started/authentication.md) - Get your API key
* [API Client Overview](/api-client/overview.md) - Learn about the client


---

# 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 dynamically by asking a question.

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

```
GET https://docs.dotpassport.io/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.