Files
panel/docs/sdk/xtls-sdk.md
2025-05-10 20:29:00 +03:00

38 lines
1.4 KiB
Markdown

---
sidebar_position: 3
title: XTLS SDK
---
import Admonition from '@theme/Admonition';
import { FaCheckCircle } from "react-icons/fa";
<Admonition type="tip" icon={<FaCheckCircle />} title="Official SDK">
This SDK is official and maintained by the Remnawave team.
</Admonition>
## @remnawave/xtls-sdk
[![NPM](https://img.shields.io/npm/v/@remnawave/xtls-sdk?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/xtls-sdk)
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk?sort=semver&style=for-the-badge&logo=github&label=GitHub)](https://github.com/remnawave/xtls-sdk)
## @remnawave/xtls-sdk-nestjs
[![NPM](https://img.shields.io/npm/v/@remnawave/xtls-sdk-nestjs?sort=semver&style=for-the-badge&logo=npm&label=NPM)](https://www.npmjs.com/package/@remnawave/xtls-sdk-nestjs)
[![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk-nestjs?sort=semver&style=for-the-badge&logo=github&label=GitHub)](https://github.com/remnawave/xtls-sdk-nestjs)
Remnawave XTLS SDK is a library for interacting with gRPC Xray API.
It can be used without any dependencies to Remnawave. There are also NestJS wrapper for this SDK.
## Installation
```bash
npm install @remnawave/xtls-sdk
```
## Usage
[Remnawave Node](https://github.com/remnawave/node) is using XTLS-SDK for interacting with Xray core API.
Checkout repository for real world usage example.