> For the complete documentation index, see [llms.txt](https://doc.vess.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.vess.id/vess-sdk/overview.md).

# Overview

**VESS KIT SDK** is a typescript library that makes it easy to work with DID/VC on VESS.

VESS content is stored in Ceramic Network, a decentralized data network, and VESS's private. cloud server. This means that data shared by users is open and available to the public.

## Install

#### Frontend

```
pnpm add vess-kit-core vess-kit-web 
```

#### Backend

```shell
pnpm add vess-kit-core vess-kit-node 
```

## Getting started

### Initialize

#### Frontend

```typescript
import { getVESSKit } from 'vess-kit-web'

const vessKit = getVESSKit()
```

#### Backend

```typescript
import { getVESSKit } from 'vess-kit-node'

const vessKit = getVESSKit()
```

### Connect ComposeDB/Ceramic

#### Frontend

```javascript
import { getVESSKit } from 'vess-kit-web'

const isDev:boolean = true
const env = isDev ? 'testnet-clay': 'mainnet'
const address = "0x....."
const provider:Web3Provider = new Web3Provider() //any web3 provider
const vessKit = getVESSKit(isDev)

const { session } = await vess.connect(address, provider, env)


```

#### Backend

```javascript
import { getVESSKit } from 'vess-kit-node'

const isDev:boolean = true
const address = "0x....."
const provider:Web3Provider = new Web3Provider() //any web3 provider
const signer = provider.getSinger()
const vessKit = getVESSKit(isDev)

const didSession = await vessKit.connect(
        address,
        async (message) => {
          const signed = await signer.signMessage(message)
          return signed
        },
        isDev ? 'testnet-clay':'mainnet',
      )

```

### Next steps:

**For more infomation, please check below.**

{% content-ref url="/pages/1lunqCuMhJrDT9Cpk5KA" %}
[API Documentation](/vess-sdk/api-documentation.md)
{% endcontent-ref %}

**Please visit here for an example of VESS-KIT usage.**

**VESS:** [**https://app.vess.id/**](https://app.vess.id/)

**Github:** [**https://github.com/cvoxelprotocol/vess-kit**](https://github.com/cvoxelprotocol/vess-kit)


---

# 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://doc.vess.id/vess-sdk/overview.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.