{"id":13577803,"url":"https://github.com/unjs/untun","last_synced_at":"2025-06-10T22:41:39.576Z","repository":{"id":188104018,"uuid":"678112150","full_name":"unjs/untun","owner":"unjs","description":"🚇 Tunnel your local HTTP(s) server to the world! powered by  Cloudflare Quick Tunnels.","archived":false,"fork":false,"pushed_at":"2024-04-14T01:31:26.000Z","size":187,"stargazers_count":891,"open_issues_count":11,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-14T10:58:35.806Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-08-13T18:07:50.000Z","updated_at":"2024-04-16T17:37:46.749Z","dependencies_parsed_at":"2023-12-07T12:24:41.712Z","dependency_job_id":"4358170c-2b0e-4671-bd4a-cd940f0d1d94","html_url":"https://github.com/unjs/untun","commit_stats":null,"previous_names":["unjs/untun"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Funtun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Funtun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Funtun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Funtun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unjs","download_url":"https://codeload.github.com/unjs/untun/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247358703,"owners_count":20926271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:01:24.465Z","updated_at":"2025-04-05T15:31:25.618Z","avatar_url":"https://github.com/unjs.png","language":"TypeScript","readme":"# 🚇 untun\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![bundle][bundle-src]][bundle-href]\n\n[![License][license-src]][license-href]\n\nTunnel your local HTTP(s) server to the world!\n\nPowered by 🔥 [Cloudflare Quick Tunnels](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/do-more-with-tunnels/trycloudflare/) and used by 👂 [unjs/listhen](https://github.com/unjs/listhen).\n\n## Usage (CLI)\n\nGlobally run tunnel with `npx`:\n\n```sh\nnpx untun@latest tunnel http://localhost:3000\n```\n\n```\n◐ Starting cloudflared tunnel to http://localhost:3000\nℹ Waiting for tunnel URL...\n✔ Tunnel ready at https://unjs-is-awesome.trycloudflare.com\n```\n\nUse `npx untun tunnel --help` for more usage info.\n\n## Usage (API)\n\nInstall package:\n\n```sh\n# npm\nnpm install untun\n\n# yarn\nyarn add untun\n\n# pnpm\npnpm install untun\n```\n\nImport:\n\n```ts\n// ESM\nimport { startTunnel } from \"untun\";\n\n// CommonJS\nconst { startTunnel } = require(\"untun\");\n```\n\nStart tunnel:\n\n```ts\nconst tunnel = await startTunnel({ port: 3000 });\n```\n\n## Options\n\n### `url`\n\n- Default: `{protocol}://{hostname}:{port}`\n\nThe local server URL to tunnel.\n\n### `port`\n\n- Default: `3000`\n\nThe local server PORT (only effective if `url` is not provided).\n\n### `hostname`\n\n- Default: `localhost`\n\nThe local server hostname (only effective if `url` is not provided).\n\n### `protocol`\n\n- Default: `http`\n\nThe local server protocol (only effective if `url` is not provided).\n\n### `verifyTLS`\n\n- Default: `false`\n\nVerify local server TLS certificate.\n\n### `acceptCloudflareNotice`\n\n- Default: `false`\n- Environment variable: `UNTUN_ACCEPT_CLOUDFLARE_NOTICE`\n\nAccept cloudflare TOS by default.\n\n## Development\n\n- Clone this repository\n- Install latest LTS version of [Node.js](https://nodejs.org/en/)\n- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`\n- Install dependencies using `pnpm install`\n- Run interactive tests using `pnpm dev`\n\n## License\n\nMade with 💛\n\nPublished under [MIT License](./LICENSE).\n\ncloudflared integration based on a fork of [JacobLinCool/node-cloudflared](https://github.com/JacobLinCool/node-cloudflared)\n\nYour installation of cloudflared software constitutes a symbol of your signature indicating that you accept the terms of the Cloudflare [License](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/license/), [Terms](https://www.cloudflare.com/terms/) and [Privacy Policy](https://www.cloudflare.com/privacypolicy/).\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/untun?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[npm-version-href]: https://npmjs.com/package/untun\n[npm-downloads-src]: https://img.shields.io/npm/dm/untun?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[npm-downloads-href]: https://npmjs.com/package/untun\n[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/untun/main?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[codecov-href]: https://codecov.io/gh/unjs/untun\n[bundle-src]: https://img.shields.io/bundlephobia/minzip/untun?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[bundle-href]: https://bundlephobia.com/result?p=untun\n[license-src]: https://img.shields.io/github/license/unjs/untun.svg?style=flat\u0026colorA=18181B\u0026colorB=F0DB4F\n[license-href]: https://github.com/unjs/untun/blob/main/LICENSE\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funjs%2Funtun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funjs%2Funtun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funjs%2Funtun/lists"}