zrok

To install dependencies:

use pnpm/yarn/npm

$ pnpm add zrok
# or
$ yarn add zrok
# or
$ npm i zrok

use bun

bun i --trust zrok

Invite

import zrok from "zrok";
const response = await zrok.invite("[email protected]");
// if success
// response.status 201
// response.statusText Created

Create Account

Check your email inbox, click the red button Create Account

Enable

// Enable your enviroment from Create Account link
// Copy the enable text for top right of your account
// paste to the enable parameter
const await zrok.enable("enalbe ************");

Sharing

const share = zrok.share("share public localhost:8080");
// kill share
share.kill();

Overview

const overview = zrok.overview();
// result
// {
//   environments: [
//     {
//       environment: [Object ...],
//     }
//   ],
// }

⚠️ Note:

如果安装失败，可以手动从https://github.com/openziti/zrok/releases下载对应平台最新的压缩包 tar.gz 格式的，直接放到 node_modules/zrok 目录，再执行

node node_modules/zrok/dist/install.js