Remnawave SDK

📦 Installation

Choose your preferred package manager:

bun

bun install @mishkat/remnawave-sdk

npm

npm install @mishkat/remnawave-sdk

yarn

yarn add @mishkat/remnawave-sdk

pnpm

pnpm add @mishkat/remnawave-sdk

🚀 Quick Start

import { RemnawaveSDK } from "@mishkat/remnawave-sdk";

const client = new RemnawaveSDK({
  panelUrl: 'https://remna.st', // or 'http://remnawave:3000' for docker network
  apiKey: "your-api-key",

  // For Caddy reverse proxy authentication (Optional)
  caddyAuthToken: "your-caddy-token",

  // For Cloudflare Zero Trust (Optional)
  cloudflareZeroTrustClientId: "your-cf-client-id",
  cloudflareZeroTrustClientSecret: "your-cf-client-secret",
});

📚 Available Controllers

The SDK provides access to 17 controllers:

• auth
• users
• nodes
• hosts
• system
• subscription
• subscriptions
• internalSquads
• externalSquads
• configProfiles
• keygen
• snippets
• hwid
• subscriptionTemplate
• subscriptionSettings
• subscriptionRequestHistory
• infraBilling

🎯 Usage Example

import { RemnawaveSDK } from "@mishkat/remnawave-sdk";

const client = new RemnawaveSDK({
  panelUrl: 'https://remna.st',
  apiKey: "your-api-key",
});

// Access any controller
const users = await client.users.getAll({ start: 0, size: 25 });
const nodes = await client.nodes.getAll();
const stats = await client.system.getStats();

🤝 Support

• GitHub: mishkatik/remnawave-sdk
• Issues: GitHub Issues