{"id":16862101,"url":"https://github.com/maelvls/ngroker","last_synced_at":"2025-03-18T15:55:59.246Z","repository":{"id":56335919,"uuid":"276913663","full_name":"maelvls/ngroker","owner":"maelvls","description":"🧸 Ngroker is a tiny helper for creating an ngrok session for pairing with my colleagues just by using their Github usernames","archived":false,"fork":false,"pushed_at":"2022-01-15T10:12:35.000Z","size":28,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-24T19:44:15.222Z","etag":null,"topics":["ngrok","pair-programming","tmux"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/maelvls.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":"2020-07-03T14:03:29.000Z","updated_at":"2022-01-15T10:13:07.000Z","dependencies_parsed_at":"2022-08-15T16:50:39.947Z","dependency_job_id":null,"html_url":"https://github.com/maelvls/ngroker","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maelvls%2Fngroker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maelvls%2Fngroker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maelvls%2Fngroker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maelvls%2Fngroker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maelvls","download_url":"https://codeload.github.com/maelvls/ngroker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244257258,"owners_count":20424127,"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":["ngrok","pair-programming","tmux"],"created_at":"2024-10-13T14:34:33.765Z","updated_at":"2025-03-18T15:55:59.214Z","avatar_url":"https://github.com/maelvls.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"![act](https://user-images.githubusercontent.com/2195781/85836295-b05bb900-b796-11ea-9565-9099a3d4b018.gif)\n\n## Install `ngroker` on Linux\n\nRequired:\n1. some binaries in your PATH + `sshd` instance running:\n   [ngrok](https://ngrok.com/download), [jl](https://github.com/koenbollen/jl),\n   [tmux](https://github.com/tmux/tmux/wiki/Installing),\n   [jq](https://stedolan.github.io/jq/download/);\n   to install all that, run:\n\n   ```sh\n   sudo apt install openssh-server tmux jq snapd\n   sudo snap install ngrok\n   go install github.com/koenbollen/jl@latest\n   ```\n  \n2. the `ngroker` script somewhere in your PATH, e.g.:\n\n   ```sh\n   curl -sL https://raw.githubusercontent.com/maelvls/ngroker/master/ngroker \u003e /tmp/ngroker\n   install /tmp/ngroker $(go env GOPATH)/bin\n   ```\n\n## Install `ngroker` on macOS\n\n(1) Make sure `sshd` is running (go to  → System Preferences → Sharing → check the box \"Remote login\")\n\n(2) Install `ngroker` by running the following commands:\n\n```sh\nbrew install jq tmux koenbollen/public/jl\nbrew cask install ngrok\ncurl -sL https://raw.githubusercontent.com/maelvls/ngroker/master/ngroker \u003e /tmp/ngroker\ninstall /tmp/ngroker /usr/local/bin\n```\n\n(2) Then, make sure you are [registered with ngrok](https://dashboard.ngrok.com/get-started/setup) (e.g. using your Github account to signup/log in)\n\n(3) Copy the `authtoken` in the [ngrok setup page](https://dashboard.ngrok.com/get-started/setup) and run:\n\n```sh\nngrok authtoken \u003cthe-token-displayed-in-get-started-setup\u003e\n```\n\n## Use `ngroker` to share a tmux session with a colleague\n\nFinally you can create a session someone by giving the script their Github\nusername (e.g. `maelvls`). The session will happen in `tmux attach -t\nngroker`\n\n```sh\n# Share session with mael\nngroker maelvls\n\n# Let's be crazy and share the session with two people!\nngroker maelvls Callisto13\n```\n\n\n## FAQ\n\n```sh\n% ssh jack@0.tcp.eu.ngrok.io -p 15597\nkex_exchange_identification: Connection closed by remote host\n```\nthat means sshd isn't running on the machine that runs `ngroker`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaelvls%2Fngroker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaelvls%2Fngroker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaelvls%2Fngroker/lists"}