openssh - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #go #golang #machine-learning #macos #windows #vue #security #ios #mcp #open-source

openssh

(★ 271)

Scriptable SSH through OpenSSH in Rust

File Explorer

Download Latest Version (.zip)

- - coverage.yml
  - features.yml
  - minimal.yml
  - msrv.yml
  - os-check.yml
  - release-plz.yml
  - shellcheck.yml
  - style.yml
  - test.yml
- dependabot.yml
- native-mux_tsp.rs
- tsp.rs
- - child.rs
  - command.rs
  - mod.rs
  - session.rs
  - stdio.rs
- - child.rs
  - command.rs
  - mod.rs
  - session.rs
- builder.rs
- changelog.rs
- child.rs
- command.rs
- error.rs
- escape.rs
- lib.rs
- port_forwarding.rs
- session.rs
- stdio.rs
- openssh.rs
.gitignore
.test-key
.test-key.pub
build_doc.sh
Cargo.toml
CHANGELOG.md
check.sh
codecov.yml
contributing.md
LICENSE-APACHE
LICENSE-MIT
README.md
run_ci_tests.sh
start_sshd.sh
stop_sshd.sh
wait_for_sshd_start_up.sh

# Installation Guide

1. Get the code

git clone https://github.com/openssh-rust/openssh

Downloads the entire project code from GitHub to your computer.

cd openssh

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Crates.io](https://img.shields.io/crates/v/openssh.svg)](https://crates.io/crates/openssh)
[![Documentation](https://docs.rs/openssh/badge.svg)](https://docs.rs/openssh/)
[![Codecov](https://codecov.io/github/openssh-rust/openssh/coverage.svg?branch=master)](https://codecov.io/gh/openssh-rust/openssh)

Scriptable SSH through OpenSSH.

This crate wraps the OpenSSH remote login client (`ssh` on most machines), and provides
a convenient mechanism for running commands on remote hosts. Since all commands are executed
through the `ssh` command, all your existing configuration (e.g., in `.ssh/config`) should
continue to work as expected.

The library's API is modeled closely after that of [`std::process::Command`], since `ssh` also
attempts to make the remote process seem as much as possible like a local command.

## License

Licensed under either of

* Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

### Run integration tests

Requires `docker` and [`cargo-hack`].

Check [getting Docker guide](https://docs.docker.com/get-docker/) on how to install docker,
and use `cargo install cargo-hack` to install [`cargo-hack`].

```
./run_ci_tests.sh
```

It will create a container which runs sshd, setup ssh-agent, and environment variables
that are required to run the integration tests.

It will also test different combination of feature flags to ensure they all compile without error.

[`cargo-hack`]: https://github.com/taiki-e/cargo-hack

### Build documentation

Requires nightly cargo.

To install nightly cargo, run `rustup toolchain install nightly`.

```
./build_doc.sh
```