# @chromaui/localtunnel 中文文档

规范地址：https://npmcn.com/package/%40chromaui/localtunnel/

版本：2\.0\.4
npm 元数据更新时间：2025-05-14T00:16:12.867Z
中文译文更新时间：2026-11-09T15:13:35.217Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chromaui/localtunnel
原文对照：https://npmcn.com/package/%40chromaui/localtunnel/?lang=original
项目主页：https://github.com/chromaui/localtunnel#readme
源码仓库：https://github.com/chromaui/localtunnel

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：24.6 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=8\.3\.0
- 运行依赖：4 个
- 首次发布：2018-10-01T02:39:50.894Z
- 最新版本发布：2021-09-17T08:40:45.714Z
- 近 30 天下载量：139519（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

向世界展示当地主人

## 安装

```sh
npm install @chromaui/localtunnel
```

也可以使用：`pnpm add @chromaui/localtunnel`、`yarn add @chromaui/localtunnel`、`bun add @chromaui/localtunnel`

## README

# @chromaui/ 本地隧道

本地隧道将你的本地主机曝光给世界 以方便测试和分享! 不需要和DNS搞混 或部署 只是让别人测试你的改变.

对浏览器测试工具如浏览器或外部的 api 调用服务如 twilio 的操作很有帮助, 调用需要公开 URL .

## 安装

```
yarn add @chromaui/localtunnel
```

## CLI 使用情况

假设您的本地服务器运行在 8000 端口上, 请使用 `lt` 命令启动隧道.

```
lt --port 8000
```

就这样! 它会连接到隧道服务器, 设置隧道, 并告诉你什么url用于你的测试。 这个url在您开会期间会一直活跃;所以,请随意与他人分享,以享受快乐的时光!

您可以任意重启本地服务器, `lt` 足够聪明,可以探测到它,一旦它回来就重新连接.

### 参数

以下是一些常见的论点。 见 `lt --help` 补充论据

-   `--subdomain` 请求本地隧道服务器上的已命名子域( 默认为随机字符)
-   `--local-host` 代理给本地主机以外的主机名

您也可以通过env变量指定参数。 E.x. (英语).

```
PORT=3000 lt
```

## API 密码

本地隧道客户端也可以通过API(用于测试集成,自动化等)使用

### localtunnel( 端口 \[,可选 \[,可召回\])

为指定的本地创建新的本地隧道 `port`将返回一个承诺,一旦你被分配到一个公共的本地隧道url . `options` 可用于请求特定 `subdomain`A级 `callback` 函数可以被传递,在这种情况下它不会返回一个承诺. 用于与旧节点风格的回调 API 的后向兼容性 。 您也可以通过单个选项对象 `port` 作为财产.

```js
const localtunnel = require('@chromaui/localtunnel');

(async () => {
  const tunnel = await localtunnel({ port: 3000 });

  // the assigned public url for your tunnel
  // i.e. https://abcdefgjhij.localtunnel.me
  tunnel.url;

  tunnel.on('close', () => {
    // tunnels are closed
  });
})();
```

#### 选项

-   `port` (数目) \[需 通过本地隧道曝光的本地端口号.
-   `subdomain` (字符串)请求代理服务器上的特定子域. **说明** 您可能无法根据可用性获得此名称 .
-   `host` 上游代理服务器的 (字符串) URL 。 默认为 `https://localtunnel.me`。 。 。 .
-   `local_host` (字符串) 代理到此主机名而不是 `localhost`。这也会导致 `Host` 在代理请求中重写为此值的页眉 .
-   `local_https` (boolean) 启用地道通到本地的 HTTPS 服务器.
-   `local_cert` (字符串) 本地 HTTPS 服务器的 PEM 文件证书路径 .
-   `local_key` (字符串) 本地 HTTPS 服务器证书密钥文件的路径 .
-   `local_ca` (字符串) 自签名证书的证书权威文件路径 .
-   `allow_invalid_cert` (boolean) 禁用您本地 HTTPS 服务器的证书检查( ignoore cert/ key/ca 选项) .

参见 [tls.create 保存文本](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) 关于证书选项的详情.

### 隧道

这个 `tunnel` 实例返回到您的召回中

| 事件 | 参数 | 说明 |
| --- | --- | --- |
| 请求 | 资讯 | 由隧道处理请求时起火,包含 _方法_ 财务报告和审定财务报表 _路径_ 字段 |
| 错误 | 错误 | 当隧道出错时起火 |
| 关闭 |  | 隧道关闭时起火 |

这个 `tunnel` 实例有以下方法:

| 方法 | 参数 | 说明 |
| --- | --- | --- |
| 关闭 |  | 关闭地道 |

## 其他客户

其他语言客户端

_离开_ [打开我](https://github.com/NoahShen/gotunnelme)

_离开_ [本地隧道](https://github.com/localtunnel/go-localtunnel)

_C#/. NET (中文(简体) )_ [本地隧道客户端](https://github.com/angelobreuer/localtunnel-client)

## 服务器

见 本地隧道/服务器 用于在服务器上授权本地隧道的细节.

## 许可证

麻省理工学院

## 常见问题

### @chromaui/localtunnel 是什么？

向世界展示当地主人

### 如何安装 @chromaui/localtunnel？

在项目目录运行 npm install @chromaui/localtunnel，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 lt，可以用 npx lt 直接运行。

### @chromaui/localtunnel 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/chromaui\_\_localtunnel 是否存在。

### @chromaui/localtunnel 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @chromaui/localtunnel 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=8\.3\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @chromaui/localtunnel 可以商用吗？

@chromaui/localtunnel 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @chromaui/localtunnel 的下载量有多少？

根据 npm 官方下载统计，@chromaui/localtunnel 在 2026/10/10 – 2026/11/08 这 30 天内被下载 139,519 次，日均约 4,651 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chromaui/localtunnel 还在维护吗？

最新版本 2\.0\.4 发布于 2021/09/17（5 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/10/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。