untun

untun

[![npm 版本][npm-version-src]][npm-version-href] [![npm 下载量][npm-downloads-src]][npm-downloads-href] [![bundle][bundle-src]][bundle-href] [![许可证][license-src]][license-href] 将您的本地 HTTP(s) 服务器隧道到全球! 由 Cloudflare 快速隧道 提供支持,并由 unjs/listhen 使用。

使用方式 (CLI)

使用 npx 在全球运行隧道:

npx untun@latest tunnel http://localhost:3000

◐ Starting cloudflared tunnel to http://localhost:3000
ℹ Waiting for tunnel URL...
✔ Tunnel ready at https://unjs-is-awesome.trycloudflare.com

要了解更多使用信息,请使用 npx untun tunnel --help。

使用 (API)

安装包:

# npm
npm install untun

# yarn
yarn add untun

# pnpm
pnpm install untun

导入:

// ESM
import { startTunnel } from "untun";

// CommonJS
const { startTunnel } = require("untun");

启动隧道:

const tunnel = await startTunnel({ port: 3000 });

选项

url

• 默认值: {protocol}://{hostname}:{port} 用于隧道的本地服务器 URL。

port

• 默认值: 3000

本地服务器端口（仅当 url 未提供时生效）。

hostname

• 默认值: localhost

本地服务器主机名（仅当 url 未提供时生效）。

protocol

• 默认值: http

本地服务器协议（仅当 url 未提供时生效）。

verifyTLS

• 默认值: false

验证本地服务器 TLS 证书。

• 克隆此仓库
• 安装最新的 LTS 版本的 Node.js
• 使用 corepack enable 启用 Corepack
• 使用 pnpm install 安装依赖项
• 使用 pnpm dev 运行交互式测试