https://github.com/maelvls/ngroker
🧸 Ngroker is a tiny helper for creating an ngrok session for pairing with my colleagues just by using their Github usernames
https://github.com/maelvls/ngroker
ngrok pair-programming tmux
Last synced: 3 months ago
JSON representation
🧸 Ngroker is a tiny helper for creating an ngrok session for pairing with my colleagues just by using their Github usernames
- Host: GitHub
- URL: https://github.com/maelvls/ngroker
- Owner: maelvls
- Created: 2020-07-03T14:03:29.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-15T10:12:35.000Z (over 3 years ago)
- Last Synced: 2025-01-24T19:44:15.222Z (4 months ago)
- Topics: ngrok, pair-programming, tmux
- Language: Shell
- Homepage:
- Size: 27.3 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Install `ngroker` on Linux
Required:
1. some binaries in your PATH + `sshd` instance running:
[ngrok](https://ngrok.com/download), [jl](https://github.com/koenbollen/jl),
[tmux](https://github.com/tmux/tmux/wiki/Installing),
[jq](https://stedolan.github.io/jq/download/);
to install all that, run:
```sh
sudo apt install openssh-server tmux jq snapd
sudo snap install ngrok
go install github.com/koenbollen/jl@latest
```
2. the `ngroker` script somewhere in your PATH, e.g.:
```sh
curl -sL https://raw.githubusercontent.com/maelvls/ngroker/master/ngroker > /tmp/ngroker
install /tmp/ngroker $(go env GOPATH)/bin
```
## Install `ngroker` on macOS
(1) Make sure `sshd` is running (go to  → System Preferences → Sharing → check the box "Remote login")
(2) Install `ngroker` by running the following commands:
```sh
brew install jq tmux koenbollen/public/jl
brew cask install ngrok
curl -sL https://raw.githubusercontent.com/maelvls/ngroker/master/ngroker > /tmp/ngroker
install /tmp/ngroker /usr/local/bin
```
(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)
(3) Copy the `authtoken` in the [ngrok setup page](https://dashboard.ngrok.com/get-started/setup) and run:
```sh
ngrok authtoken
```
## Use `ngroker` to share a tmux session with a colleague
Finally you can create a session someone by giving the script their Github
username (e.g. `maelvls`). The session will happen in `tmux attach -t
ngroker`
```sh
# Share session with mael
ngroker maelvls
# Let's be crazy and share the session with two people!
ngroker maelvls Callisto13
```
## FAQ
```sh
% ssh [email protected] -p 15597
kex_exchange_identification: Connection closed by remote host
```
that means sshd isn't running on the machine that runs `ngroker`