sish icon indicating copy to clipboard operation
sish copied to clipboard

Usage guide via SSH

Open bibo38 opened this issue 1 year ago • 1 comments

As I use sish/SSH port forwarding rarely, I often forget how to do stuff. Looking it up online is ok, but it would be much more convenient, if sish would simply provide me a help page when I use it the wrong way (like other command line programs).

My feature list:

  • [ ] Show a recommendation for common error cases. My most prominent is getting confused with -L and -R. E.g. ssh -L foo:80:localhost:8080 ssi.sh should result in smth. like Local forwarding not found. If you want to forward localhost:8080 to foo.ssi.sh, use ssh -R ...
  • [ ] Show a quick help page when called without a valid connection (e.g. just ssh ssi.sh or some uncommon error case). This page should feature one example for each supported forwarding type with maybe one sentence describing what the example does. Also it should refer to the command for the detailed help pages.
  • [ ] Add detailed help pages for each forwarding type. E.g. ssh ssi.sh help tcp should print a detailed help of the TCP port forwarding. This can be copied from the README of sish.
  • [ ] And it would be super nice, if these help pages are customized to the running sish instance. E.g. replace ssi.sh with the actual domain name, remove things like TCP port forwarding, when these are not enabled and alter the description/examples for things like randomized subdomains and binding the root domain.

bibo38 avatar May 27 '23 22:05 bibo38

This would be a cool feature! Not sure if/when I can get to it, but leaving this open as a potential good first issue!

antoniomika avatar Oct 08 '23 15:10 antoniomika