SSH.NET
SSH.NET copied to clipboard
sshnet
Documentation seems basically non-existant
The only docs I can find are on the CodePlex site which consists of a zip (The "SshClient.chm" link just points to the same page).
The zip is basically useless. Absolute links to C:/wikipage, blank files, examples with wrong parameter order, etc, etc.
Am I missing something? Is there more complete documentation somewhere?
There is MSDN-style class documentation in a .chm file for each release, which you can find on the GitHub releases page.
Here is the link to the latest help file. https://github.com/sshnet/SSH.NET/releases/download/2016.1.0/SSH.NET-2016.1.0-help.chm
Windows 10 prevents the chm from rendering the texts. You will need to right click the chm file and check the "Unblock" option.
Page: https://community.spiceworks.com/topic/1961503-solved-windows-10-chm-help-files-showing-up-blank
Image: https://content.spiceworksstatic.com/service.community/p/post_images/0000226450/58921218/attached_image/Unblock.png
Please, give sample usages of the SshClient. I would like to run a set of commands in the SAME session, but it seems the client runs every command in a new session.
Hate to jump on the band wagon but docs (not those generated by GhostDoc) would be super awesome. Having issues trying to get commands to even execute properly in some cases but there is nothing to refer to in order to figure out if I am using the correct commands, sequences, etc. Have found there are multiple ways to use SSH related classes and functionality but again, no docs to tell me if I should be doing this and if there are any side effects or caveats to this approach.
Great job on the code, would be even better if there were docs to go with it.
This issue is strongly related to Issue# 176. I'm not sure which should be closed as duplicate, but this one has more comments.
How do we escalate this, and how can we help? @drieseng asked for a pull request in #176 so I'm going to make a PR on the README.md. Fingers crossed that it gets accepted after Gert is finished cleaning @rickerj135's clothing in Stuttgart. 😉
If community edits to README.md is not the way to go, at the very least PLEASE add a link to the latest help.chm file to the front page README.md in the Introduction section (along with a note telling people they need to right-click and "unblock").
As a number of people have commented, the code seems to be very well written. This means there must be some well written design documents somewhere.
@drieseng what have you been using as design docs? The README.md says this implementation is based on a Sharp.SSH library. I'm happy to start from documentation for a library based in any other project or any other language. I just want to make sure I'm looking at the same docs you have been using as you have been jamming on this awesome (imho) project.
Why not switch to markdown help or the wiki?
I think only @drieseng can do it, but someone should open up the project wiki for public editing: https://help.github.com/en/github/building-a-strong-community/changing-access-permissions-for-wikis
In the latest release there is no .chm file anymore? Is this by error?
@WojciechNagorski, didn't you use the MSBuild script to build the release?
Yes. I have to upload it. But right now I don't have too much free time. I will be able to do it next week.
