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

# Installation

## Package managers

{% tabs %}
{% tab title="npm" %}

```bash
npm install cifer-sdk
```

{% endtab %}

{% tab title="Yarn" %}

```bash
yarn add cifer-sdk
```

{% endtab %}

{% tab title="pnpm" %}

```bash
pnpm add cifer-sdk
```

{% endtab %}
{% endtabs %}

## TypeScript configuration

```json
{
  "compilerOptions": {
    "moduleResolution": "bundler",
    "target": "ES2020",
    "lib": ["ES2020", "DOM"]
  }
}
```

The package supports ESM and CommonJS and includes TypeScript declarations.

```typescript
// ESM
import { createCiferSdk, keyManagement, blackbox } from 'cifer-sdk';

// CommonJS
const { createCiferSdk } = require('cifer-sdk');
```

## Subpath exports

```typescript
import { Eip1193SignerAdapter, RpcReadClient } from 'cifer-sdk/adapters';
import { encryptPayload, decryptPayload } from 'cifer-sdk/blackbox';
import { buildCreateSecretTx } from 'cifer-sdk/keyManagement';
import * as web2 from 'cifer-sdk/web2';
```

## Runtime profile

Cifer SDK has no peer dependency and no dependency on a wallet framework. It uses `@noble/secp256k1` and `@noble/hashes` for cryptographic adapter support. Typical compressed bundle size depends on imported modules and tree-shaking.

## Verify discovery

```typescript
import { createCiferSdk } from 'cifer-sdk';

const sdk = await createCiferSdk({
  blackboxUrl: 'https://blackbox.cifersecurity.com:3010',
});

console.log('Supported chains:', sdk.getSupportedChainIds());
```


---

# 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, and the optional `goal` query parameter:

```
GET https://cifer.gitbook.io/cifer-docs/documentation/cifer-sdk/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.