https://github.com/genotrance/nimssh2
Nimssh2 is a Nim wrapper for the libssh2 library
https://github.com/genotrance/nimssh2
c2nim libssh2 nim nimble nimgen ssh2
Last synced: 4 months ago
JSON representation
Nimssh2 is a Nim wrapper for the libssh2 library
- Host: GitHub
- URL: https://github.com/genotrance/nimssh2
- Owner: genotrance
- License: mit
- Created: 2018-01-06T01:22:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-07T05:57:02.000Z (over 7 years ago)
- Last Synced: 2025-04-06T17:22:11.461Z (10 months ago)
- Topics: c2nim, libssh2, nim, nimble, nimgen, ssh2
- Language: Nim
- Size: 5.86 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Nimssh2 is a [Nim](https://nim-lang.org/) wrapper for the [libssh2](https://github.com/libssh2/libssh2) library.
Nimssh2 is distributed as a [Nimble](https://github.com/nim-lang/nimble) package and depends on [nimgen](https://github.com/genotrance/nimgen) and [c2nim](https://github.com/nim-lang/c2nim/) to generate the wrappers. The libssh2 source code is downloaded using Git so having ```git``` in the path is required.
__Installation__
Nimssh2 can be installed via [Nimble](https://github.com/nim-lang/nimble):
```
> nimble install nimssh2
```
This will download, wrap and install nimssh2 in the standard Nimble package location, typically ~/.nimble. Once installed, it can be imported into any Nim program.
__Usage__
Module documentation can be found [here](http://nimgen.genotrance.com/nimssh2).
```nim
import nimssh2/libssh2
echo libssh2_init(0)
```
__Credits__
Nimssh2 wraps the libssh2 source code and all licensing terms of [libssh2](https://www.libssh2.org/license.html) apply to the usage of this package.
Credits go out to [c2nim](https://github.com/nim-lang/c2nim/) as well without which this package would be greatly limited in its abilities.
__Feedback__
Nimssh2 is a work in progress and any feedback or suggestions are welcome. It is hosted on [GitHub](https://github.com/genotrance/nimssh2) with an MIT license so issues, forks and PRs are most appreciated.