https://github.com/grottopress/simple_ssh
Simple stateless SSH communication
https://github.com/grottopress/simple_ssh
crystal ssh
Last synced: 11 months ago
JSON representation
Simple stateless SSH communication
- Host: GitHub
- URL: https://github.com/grottopress/simple_ssh
- Owner: GrottoPress
- License: mit
- Created: 2021-05-08T15:41:16.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T13:24:46.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T08:35:32.605Z (almost 2 years ago)
- Topics: crystal, ssh
- Language: Crystal
- Homepage:
- Size: 15.6 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple SSH
**Simple SSH** enables running commands against a remote host via SSH. It is **not** an implementation of the protocol, but relies on any existing SSH client program installed on the client machine (eg: *OpenSSH*).
*Simple SSH* is stateless, in that a connection is initiated and terminated for every request, after a response is received. Commands can be pipelined, allowing to send multiple commands in a single request.
*Simple SSH* assumes public key authentication, where a client's public key is expected to be listed in the server's `~/.ssh/authorized_keys` file. No other authentication methods are supported at this time.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
simple_ssh:
github: GrottoPress/simple_ssh
```
2. Run `shards install`
## Usage
- Run single command:
```crystal
require "simple_ssh"
ssh = SimpleSsh.new("root", ip: "127.0.0.1")
# <= `port:` defaults to '22'
ssh.run("ls /root") do |response|
puts response.status.success? # <= true
response.output.try do |output|
ouput.each_line { |line| puts line }
end
response.error.try do |error|
error.each_line { |line| puts line }
end
end
```
- Run multiple (pipelined) commands:
```crystal
require "simple_ssh"
ssh = SimpleSsh.new("username", "my.host.name", 2222)
ssh << "ls /root"
ssh << "cat /non-existent"
# <= Alias: `ssh.command(...)`
ssh.run do |responses|
puts responses.size # <= 2
# <= Responses follow the order of the commands:
# <= `responses[0]` is for "ls /root"
# <= `responses[1]` is for "cat /non-existent"
responses.each do |response|
puts response.status.exit_code
response.output.try do |output|
ouput.each_line { |line| puts line }
end
response.error.try do |error|
error.each_line { |line| puts line }
end
end
end
```
## Development
Run tests with `docker-compose run --rm spec`. If you need to update shards before that, run `docker-compose run --rm shards`.
## Contributing
1. [Fork it](https://github.com/GrottoPress/mel/fork)
1. Switch to the `master` branch: `git checkout master`
1. Create your feature branch: `git checkout -b my-new-feature`
1. Make your changes, updating changelog and documentation as appropriate.
1. Commit your changes: `git commit`
1. Push to the branch: `git push origin my-new-feature`
1. Submit a new *Pull Request* against the `GrottoPress:master` branch.