{"id":18657893,"url":"https://github.com/lightsofapollo/ngrok-services","last_synced_at":"2025-07-02T11:40:29.564Z","repository":{"id":13677559,"uuid":"16371275","full_name":"lightsofapollo/ngrok-services","owner":"lightsofapollo","description":"Hacks for ngrok to use it in an automated fashion for testing/development/etc...","archived":false,"fork":false,"pushed_at":"2014-01-31T19:03:16.000Z","size":6680,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-27T15:12:44.336Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lightsofapollo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-30T07:50:19.000Z","updated_at":"2017-11-29T19:20:49.000Z","dependencies_parsed_at":"2022-09-02T14:02:27.637Z","dependency_job_id":null,"html_url":"https://github.com/lightsofapollo/ngrok-services","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Fngrok-services","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Fngrok-services/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Fngrok-services/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Fngrok-services/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightsofapollo","download_url":"https://codeload.github.com/lightsofapollo/ngrok-services/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239475960,"owners_count":19645041,"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-11-07T07:30:17.791Z","updated_at":"2025-02-18T12:53:14.920Z","avatar_url":"https://github.com/lightsofapollo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ngrok-services\n\n[![Build Status](https://travis-ci.org/lightsofapollo/ngrok-services.png?branch=master)](https://travis-ci.org/lightsofapollo/ngrok-services)\n\nNode based wrapper for ngrok... Ideally this would be baked into ngrok\n(or as a go client) but as an inital PoC I wrote this by wrapping ngrok.\n\n## Features\n\n  - machine readable (json) output\n  - multiple (machine readable) output formats from start/restart (json/env file)\n\n## Usage\n\n### CLI\n\n```sh\nngrok-services --help\n```\n\n```\n  Usage: ngrok-services [options] [command]\n\n  Commands:\n\n    stop [config]          terminate ngrok tunneling\n    start [config]         start running ngrok with the config\n    restart [config]       ensure the service is running by stopping/starting\n\n  Options:\n\n    -h, --help             output usage information\n    -p, --pid-file \u003cpath\u003e  pid file location\n    -f, --format \u003cname\u003e    name of formatter [env|json]\n```\n\n### Config Files\n\ncreate a `ngrok_services.json` (can also be a js file) like this:\n\n``` json\n{\n  \"http\": { \"port\": 8080 },\n  \"amqp\": { \"port\": 5701, \"proto\": \"tcp\", \"authtoken\": \"...\" },\n}\n```\n\nThen it can be manipulated via `ngrok-services`:\n\n## Examples\n\n```sh\n# usage is global ngrok-services might be at ./node_modules/.bin/ngrok-services\nngrok-services start\nngrok-services stop\nngrok-services restart\n```\n\n```sh\n# can also be used with paths\nngrok-services start some_folder\nngrok-services stop some_folder\nngrok-services restart some_folder\n```\n\n```sh\n# output formats\nngrok-services start -f env\nngrok-services start -f json\nngrok-services start -f ./path/to/custom/thing\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightsofapollo%2Fngrok-services","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightsofapollo%2Fngrok-services","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightsofapollo%2Fngrok-services/lists"}