pipeprogress 2020.6.0

Progress bar for long pipe operations
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

# Pipe Progress

## Table of Contents

<!-- TOC -->

- [Pipe Progress](#pipe-progress)
    - [Table of Contents](#table-of-contents)
    - [Workflow Status](#workflow-status)
    - [Overview](#overview)
    - [Usage](#usage)
        - [Pre-build release](#pre-build-release)
        - [Cargo release](#cargo-release)
        - [From source](#from-source)

<!-- /TOC -->


## Status

| Status | Description |
| :----- | :---------- |
| ![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=salt-labs/pipeprogress) | Dependency checker |
| ![Rust](https://github.com/salt-labs/pipeprogress/workflows/Rust/badge.svg) | Rust |
| ![Greetings](https://github.com/salt-labs/pipeprogress/workflows/Greetings/badge.svg) | Greets new users to the project. |
| ![Kaniko](https://github.com/salt-labs/pipeprogress/workflows/Kaniko/badge.svg) | Testing and building containers with Kaniko |
| ![Labeler](https://github.com/salt-labs/pipeprogress/workflows/Labeler/badge.svg) | Automates label addition to issues and PRs |
| ![Release](https://github.com/salt-labs/pipeprogress/workflows/Release/badge.svg) | Ships new releases :ship: |
| ![Stale](https://github.com/salt-labs/pipeprogress/workflows/Stale/badge.svg) | Checks for Stale issues and PRs  |

## Overview

Pipe Progress is a command-line utility to display progress during long pipe operations.

This utility was created as part of the *amazing* training course titled ***Hands-On Systems Programming with Rust*** by [Nathan Stocks](https://github.com/cleancut). The course content is available from [O'Reilly](https://learning.oreilly.com/videos/hands-on-systems-programming/9781838822132).

## Usage

There are a couple of different methods to running the code from this repository.

### Pre-build release

Download a prebuilt release in your desired architecture and place the binary into your ```PATH``` before running the following.

```bash
pp --help
```

### Cargo release

Pipe Progress can be installed using cargo as follows

```bash
cargo install pipeprogress

pp --help
```

### From source

If you want to run from source, you can clone this repository and build with cargo as follows.

```bash
git clone git@github.com:salt-labs/pipeprogress.git

cd pipeprogress

cargo build --release

./target/release/pp --help
```