{"id":30325721,"url":"https://github.com/stacksjs/localtunnels","last_synced_at":"2025-08-17T23:07:17.961Z","repository":{"id":267354003,"uuid":"766047982","full_name":"stacksjs/localtunnels","owner":"stacksjs","description":"🚇 A simple and smart tunneling alternative. Without or with self-hosting.","archived":false,"fork":false,"pushed_at":"2025-08-13T22:57:15.000Z","size":20040,"stargazers_count":9,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-14T00:25:03.054Z","etag":null,"topics":["dev-tool","expose","local-development","localtunnel","ngrok","tunnel"],"latest_commit_sha":null,"homepage":"https://localtunnel.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stacksjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stacksjs","chrisbbreuer"],"open_collective":"stacksjs"}},"created_at":"2024-03-02T07:32:08.000Z","updated_at":"2025-08-09T15:37:22.000Z","dependencies_parsed_at":"2024-12-09T21:33:48.326Z","dependency_job_id":"c0a3bc71-8f9e-4e82-b3bf-7e4167b658e3","html_url":"https://github.com/stacksjs/localtunnels","commit_stats":null,"previous_names":["stacksjs/localtunnels"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/stacksjs/localtunnels","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Flocaltunnels","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Flocaltunnels/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Flocaltunnels/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Flocaltunnels/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stacksjs","download_url":"https://codeload.github.com/stacksjs/localtunnels/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacksjs%2Flocaltunnels/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270918404,"owners_count":24667679,"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","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dev-tool","expose","local-development","localtunnel","ngrok","tunnel"],"created_at":"2025-08-17T23:07:17.316Z","updated_at":"2025-08-17T23:07:17.943Z","avatar_url":"https://github.com/stacksjs.png","language":"TypeScript","funding_links":["https://github.com/sponsors/stacksjs","https://github.com/sponsors/chrisbbreuer","https://opencollective.com/stacksjs"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://github.com/stacksjs/localtunnels/blob/main/.github/art/cover.jpg?raw=true\" alt=\"Social Card of this repo\"\u003e\u003c/p\u003e\n\n[![npm version][npm-version-src]][npm-version-href]\n[![GitHub Actions][github-actions-src]][github-actions-href]\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\u003c!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] --\u003e\n\u003c!-- [![Codecov][codecov-src]][codecov-href] --\u003e\n\n# localtunnels\n\n\u003e A zero-config local tunnel that's simple, lightweight, and secure.\n\n## Features\n\n- Simple, lightweight local tunnel\n- Security built-in, including HTTPS\n- IAC, self-hostable _(via AWS)_\n- Custom subdomains\n- CLI \u0026 Library\n\n## Install\n\n```sh\nbun install -d localtunnels\n```\n\n\u003c!-- _Alternatively, you can install:_\n\n```sh\nbrew install localtunnels # wip\npkgx install localtunnels # wip\n``` --\u003e\n\n## Get Started\n\nThere are two ways of using this local tunnel: _as a library or as a CLI._\n\n### Library\n\nGiven the npm package is installed:\n\n```ts\nimport type { LocalTunnelConfig } from 'localtunnels'\nimport { startLocalTunnel } from 'localtunnels'\n\nconst config: LocalTunnelConfig = {\n  from: 'localhost:5173',\n  domain: 'stacksjs.dev', // optional, defaults to the stacksjs.dev domain\n  subdomain: 'test', // optional, uses a random subdomain by default\n  verbose: true, // optional, defaults to false\n}\n\nstartLocalTunnel(config)\n```\n\nYou may als use a configuration file:\n\n```ts\n// tunnel.config.{ts,js}\nimport type { LocalTunnelConfig } from '@stacksjs/localtunnels'\n\nconst config: LocalTunnelConfig = {\n  from: 'localhost:5173',\n  domain: 'stacksjs.dev', // optional, defaults to the stacksjs.dev domain\n  subdomain: 'test', // optional, uses a random subdomain by default\n  verbose: true, // optional, defaults to false\n}\n\nexport default config\n```\n\n_Then run:_\n\n```sh\n./localtunnels start\n```\n\n### CLI\n\n```sh\nlocaltunnels start --from localhost:5173 --subdomain test --verbose\nlocaltunnels --help\nlocaltunnels --version\n```\n\nTo learn more, head over to the [documentation](https://localtunnels.sh/).\n\n## Testing\n\n```sh\nbun test\n```\n\n## Changelog\n\nPlease see our [releases](https://github.com/stacksjs/localtunnels/releases) page for more information on what has changed recently.\n\n## Contributing\n\nPlease review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.\n\n## Community\n\nFor help, discussion about best practices, or any other conversation that would benefit from being searchable:\n\n[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)\n\nFor casual chit-chat with others using this package:\n\n[Join the Stacks Discord Server](https://discord.gg/stacksjs)\n\n## Postcardware\n\n“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where `localtunnels` is being used! We showcase them on our website too.\n\nOur address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎\n\n## Sponsors\n\nWe would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.\n\n- [JetBrains](https://www.jetbrains.com/)\n- [The Solana Foundation](https://solana.com/)\n\n## Credits\n\n- [Chris Breuer](https://github.com/chrisbbreuer)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.\n\nMade with 💙\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/localtunnels?style=flat-square\n[npm-version-href]: https://npmjs.com/package/localtunnels\n[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/localtunnels/ci.yml?style=flat-square\u0026branch=main\n[github-actions-href]: https://github.com/stacksjs/localtunnels/actions?query=workflow%3Aci\n\n\u003c!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/localtunnels/main?style=flat-square\n[codecov-href]: https://codecov.io/gh/stacksjs/localtunnels --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacksjs%2Flocaltunnels","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstacksjs%2Flocaltunnels","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacksjs%2Flocaltunnels/lists"}