scrut 0.4.3

A simple and powerful test framework for CLI applications
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
72
73
74
75
76
77

---
sidebar_position: 1
---

import OssNote from '../fb/components/_oss-note.md';

# Installation

<FbInternalOnly><OssNote /></FbInternalOnly>


We provide a couple of different ways to install Scrut. Choose whatever fits best for you:

## Install via Script (Linux, Mac)

Execute the following from your shell:

```bash title="Terminal"
$ curl --proto '=https' --tlsv1.2 -sSf https://facebookincubator.github.io/scrut/install.sh | sh
```

This will
- Download and unpack the latest Scrut binary
- Install the binary in your local path (either `~/bin` or `~/.local/bin`, whichever exists)

The following parameters are supported:

| Name                        | Description                                           | Default                           |
| --------------------------- | ----------------------------------------------------- | --------------------------------- |
| `--verbose`, `-v`           | Explicitly log everything that is executed (`set -x`) | -                                 |
| `--owner-repo`, `-r`        | Github owner and repository in format OWNER/REPO      | `facebookincubator/scrut`         |
| `--installation-path`, `-p` | Set installation path                                 | `$HOME/bin` or `$HOME/.local/bin` |

You can supply them by appending them like so:

```bash title="Terminal"
$ curl --proto '=https' --tlsv1.2 -LsSf https://facebookincubator.github.io/scrut/install.sh | sh -s -- -p /my/install/directory
```

## Install via Pre-Build Binaries (Linux, Mac, Windows)

Head over to [https://github.com/facebookincubator/scrut/releases/latest](https://github.com/facebookincubator/scrut/releases/latest) and select the appropriate binary for your operating system.

Once downloaded and unpacked move the binary `scrut` (or `scrut.exe` on Windows) to a directory in your `PATH`.

## Install via Cargo (Linux, Mac, Windows)

You need to have a working [Rust setup](https://www.rust-lang.org/tools/install) installed on your local machine. Then you can build and install the `scrut` binary as any other Rust binary:

```bash
$ cargo install scrut
```

This will install the `scrut` binary after building it in your local cargo binary folder (`~/.cargo/bin` on Linux and Mac, `%USERPROFILE%\.cargo\bin` on Windows).

If you want to install the binary manually then you need to check out the [repository](https://github.com/facebookincubator/scrut) and then build it with:

```
$ cargo build --release --bin scrut
```

This will create `target/release/scrut` which you now can move to a directory in your `PATH`.

## Install via Homebrew (Mac)

Coming soon

## Verify

Now that you have downloaded the binary and stored it in your `PATH` verify that you can execute the following before proceeding:

```bash title="Terminal"
$ scrut --version
scrut v0.X.Y
```

(You will see the latest version here)