diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf7bfa9 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# fwd + +A port-forwarding utility. + +Here's how it works: + +1. You install `fwd` on the server. +2. You install `fwd` on the client. +3. You run `fwd` on the client to connect to the server, like so: + +```bash +doty@my.laptop$ fwd some.server +``` + +`fwd` will connect to `some.server` via ssh, and then show you a screen listing all of the ports that the server is listening on locally. +Use the up and down arrow keys (or `j`/`k`) to select the port you're interested in and press `e` to toggle forwarding of that port. +Now, connections to that port locally will be forwarded to the remote server. + +If the port is something that might be interesting to a web server, you can press `` with the port selected to open a browser pointed at that port. + +If something is going wrong, pressing `l` will toggle logs that might explain it. + +Press `q` to quit.