spurs 0.4.1

Utilities for setting up and running experiments remotely
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# spurs

[![Latest version](https://img.shields.io/crates/v/spurs.svg)](https://crates.io/crates/spurs)
[![Documentation](https://docs.rs/spurs/badge.svg)](https://docs.rs/spurs)
[![Build](https://api.travis-ci.org/mark-i-m/spurs.svg)](https://travis-ci.org/mark-i-m/spurs/)

Utilities for setting up and running experiments remotely.

spurs is heavily inspired by [spur.py](https://github.com/mwilliamson/spur.py)
but it also contains a bunch of utility routines that I have found useful. I
will periodically add more as I find useful ones or people submit PRs.

## Features

- A straight-forward, well-typed, idiomatic interface for running commands
  remotely via SSH, similar to `spur.py`.
- Utilities for common Linux admin operations, such as adding a user to a group
  or turning on a swap device or installing a package. This is by no means a
  complete set of such functions. So far it just includes the ones I have run
  into. Feel free to make PRs adding more.

## Example

```rust
use spurs::{cmd, ssh::{SshShell, Execute}};

const FOO: &str = "foo";
const HOST: &str = "1.2.3.4:22";
const USER: &str = "user";

// Create an SSH connection with host.
// (host doesn't have to be a `&str`; it can be any `ToSocketAddrs` type)
let shell = SshShell::with_default_key(USER, HOST)?;

// Run some commands on HOST as USER.

// ps -e | grep foo
shell.run(cmd!("ps -e | grep {}", FOO).use_bash())?;

// cd /home/user ; ls -a | grep user
shell.run(cmd!("ls -a | grep user").cwd("/home/user/").use_bash())?;

// sudo yum install -y qemu-kvm
shell.run(spurs::centos::yum_install(&["qemu-kvm"]))?;
```

It's also possible to
- run commands in another thread and later wait for that thread
- capture the stdout and stderr
- allow a command to fail

For more information please see [the docs](https://docs.rs/spurs). Feel free to
open an issue on [the repo](https://github.com/mark-i-m/spurs) if anything is
unclear.

## Usage

Add the crate `spurs` to your `Cargo.toml` dependencies.

Requires stable Rust 1.32 or newer.

## 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.