{"id":18402092,"url":"https://github.com/khrj/ngrok","last_synced_at":"2025-07-10T00:03:52.858Z","repository":{"id":44531215,"uuid":"307043727","full_name":"khrj/ngrok","owner":"khrj","description":"Expose your localhost to the web. Ultra-simple deno wrapper for ngrok.","archived":false,"fork":false,"pushed_at":"2022-08-03T20:43:01.000Z","size":89,"stargazers_count":11,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-21T20:47:13.990Z","etag":null,"topics":["deno","expose","localhost","module","ngrok","web","wrapper"],"latest_commit_sha":null,"homepage":"https://deno.land/x/ngrok","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/khrj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-25T07:10:35.000Z","updated_at":"2024-02-09T09:10:45.000Z","dependencies_parsed_at":"2022-09-17T00:12:38.582Z","dependency_job_id":null,"html_url":"https://github.com/khrj/ngrok","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/khrj/ngrok","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khrj%2Fngrok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khrj%2Fngrok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khrj%2Fngrok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khrj%2Fngrok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khrj","download_url":"https://codeload.github.com/khrj/ngrok/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khrj%2Fngrok/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264505739,"owners_count":23618965,"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":["deno","expose","localhost","module","ngrok","web","wrapper"],"created_at":"2024-11-06T02:41:07.471Z","updated_at":"2025-07-10T00:03:52.840Z","avatar_url":"https://github.com/khrj.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"assets/logo.svg\" width=\"350\" height=\"350\" alt=\"trains between usb and usb port abstract illustration\"\u003e\n    \u003ch1\u003engrok\u003c/h1\u003e\n    \u003cp\u003e\n        \u003cb\u003eExpose your localhost to the web. Ultra-simple deno wrapper for ngrok\u003c/b\u003e\n    \u003c/p\u003e\n    \u003cp\u003e\n        \u003cimg alt=\"build status\" src=\"https://img.shields.io/github/workflow/status/khrj/ngrok/Deno?label=checks\" \u003e\n        \u003cimg alt=\"language\" src=\"https://img.shields.io/github/languages/top/khrj/ngrok\" \u003e\n        \u003cimg alt=\"code size\" src=\"https://img.shields.io/github/languages/code-size/khrj/ngrok\"\u003e\n        \u003cimg alt=\"issues\" src=\"https://img.shields.io/github/issues/khrj/ngrok\" \u003e\n        \u003cimg alt=\"license\" src=\"https://img.shields.io/github/license/khrj/ngrok\"\u003e\n        \u003cimg alt=\"version\" src=\"https://img.shields.io/github/v/release/khrj/ngrok\"\u003e\n    \u003c/p\u003e\n    \u003cp\u003e\n        \u003cb\u003e\u003ca href=\"https://deno.land/x/ngrok\"\u003eView on deno.land\u003c/a\u003e\u003c/b\u003e\n    \u003c/p\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n\u003c/div\u003e\n\n## Usage\n\n```ts\nimport { Ngrok } from \"https://deno.land/x/ngrok@4.0.2/mod.ts\"\n\nconst ngrok = await Ngrok.create({\n    protocol: \"http\",\n    port: 8080,\n})\n\nngrok.addEventListener(\"ready\", (event) =\u003e {\n    console.log(event.detail) // Outputs a URL without the protocol, such as \"33a229cb0344.ngrok.io\"\n})\n\n// ...\n\nawait ngrok.destroy()\n```\n\n- `Ngrok.create` accepts `NgrokOptions`\n\n```ts\ninterface NgrokOptions {\n    protocol: string\n    port: number\n    region?: string\n    subdomain?: string\n    authtoken?: string\n    extraArgs?: string[]\n}\n```\n\n### Disconnecting\n\nDue to the way child-processes work, ngrok will continue running in the\nbackground even after your program exits unless you destroy the instance\n\n```ts\nimport { Ngrok } from \"https://deno.land/x/ngrok@4.0.2/mod.ts\"\n\nconst ngrok = await Ngrok.create({\n    protocol: \"http\",\n    port: 8080,\n})\n\nawait ngrok.destroy()\n```\n\n- Optionally provide an exit code: `await ngrok.destroy(\"SIGKILL\")`\n\n### API\n\nSee [generated documentation](https://doc.deno.land/https/deno.land/x/ngrok@4.0.2/mod.ts)\n\n## Permissions\n\n- --allow-read\n- --allow-write\n- --allow-env\n- --allow-net\n- --allow-run\n\n```bash\ndeno run --allow-read --allow-write --allow-env --allow-net --allow-run test.ts\n```\n\nalternatively, specify only -A\n\n```bash\ndeno run -A test.ts\n```\n\n## Supporters\n\n[![Stargazers repo roster for @khrj/ngrok](https://reporoster.com/stars/khrj/ngrok)](https://github.com/khrj/ngrok/stargazers)\n\n[![Forkers repo roster for @khrj/ngrok](https://reporoster.com/forks/khrj/ngrok)](https://github.com/khrj/ngrok/network/members)\n\n## Related\n\n- [Deno modules](https://github.com/khrj/deno-modules)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhrj%2Fngrok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhrj%2Fngrok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhrj%2Fngrok/lists"}