https://github.com/fnichol/piawg

Last synced: 3 months ago
JSON representation
Host: GitHub
URL: https://github.com/fnichol/piawg
Owner: fnichol
License: mpl-2.0
Created: 2021-07-06T00:35:24.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-06-08T00:03:18.000Z (about 2 years ago)
Last Synced: 2025-03-24T03:09:17.212Z (3 months ago)
Language: Rust
Size: 121 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        


  


  piawg

  






  TODO(fnichol): fill in



|                  |                                                                                          |

| ---------------: | ---------------------------------------------------------------------------------------- |

|               CI | [![CI Status][badge-ci-overall]][ci]
 [![Bors enabled][badge-bors]][bors-dashboard] |

|   Latest Version | [![Latest version][badge-version]][crate]                                                |

|    Documentation | [![Documentation][badge-docs]][docs]                                                     |

|  Crate Downloads | [![Crate downloads][badge-crate-dl]][crate]                                              |

| GitHub Downloads | [![Github downloads][badge-github-dl]][github-releases]                                  |

|     Docker Pulls | [![Docker pulls][badge-docker-pulls]][docker]                                            |

|          License | [![Crate license][badge-license]][github]                                                |

Table of Contents

- [CLI](#cli)

  - [Usage](#usage)

  - [Installation](#installation)

    - [install.sh (Pre-Built Binaries)](#installsh-pre-built-binaries)

    - [GitHub Releasees (Pre-Built Binaries)](#github-releasees-pre-built-binaries)

    - [Cargo Install](#cargo-install)

    - [From Source](#from-source)

- [Library](#library)

  - [Usage](#usage-1)

  - [Examples](#examples)

- [CI Status](#ci-status)

  - [Build (main branch)](#build-main-branch)

  - [Test (main branch)](#test-main-branch)

  - [Check (main branch)](#check-main-branch)

- [Code of Conduct](#code-of-conduct)

- [Issues](#issues)

- [Contributing](#contributing)

- [Release History](#release-history)

- [Authors](#authors)

- [License](#license)

## CLI

### Usage

TODO(fnichol): fill in

For more help and full usage, use the `--help` or `-h` flags:

```sh

piawg --help

```

### Installation

#### install.sh (Pre-Built Binaries)

An installer is provided at  which

installs a suitable pre-built binary for common systems such as Linux, macOS,

Windows, and FreeBSD. It can be downloaded and run locally or piped into a shell

interpreter in the "curl-bash" style as shown below. Note that if you're opposed

to this idea, feel free to check some of the alternatives below.

To install the latest release for your system into `$HOME/bin`:

```sh

curl -sSf https://fnichol.github.io/piawg/install.sh | sh

```

When the installer is run as `root` the installation directory defaults to

`/usr/local/bin`:

```sh

curl -sSf https://fnichol.github.io/piawg/install.sh | sudo sh

```

A [nightly] release built from `HEAD` of the main branch is available which can

also be installed:

```sh

curl -sSf https://fnichol.github.io/piawg/install.sh \

    | sh -s -- --release=nightly

```

For a full set of options, check out the help usage with:

```sh

curl -sSf https://fnichol.github.io/piawg/install.sh | sh -s -- --help

```

#### GitHub Releasees (Pre-Built Binaries)

Each release comes with binary artifacts published in [GitHub

Releases][github-releases]. The `install.sh` program downloads its artifacts

from this location so this serves as a manual alternative. Each artifact ships

with MD5 and SHA256 checksums to help verify the artifact on a target system.

#### Cargo Install

If [Rust](https://rustup.rs/) is installed on your system, then installing with

Cargo is straight forward with:

```sh

cargo install piawg

```

#### From Source

To install from source, you can clone the Git repository, build with Cargo and

copy the binary into a destination directory. This will build the project from

the latest commit on the main branch, which may not correspond to the latest

stable release:

```sh

git clone https://github.com/fnichol/piawg.git

cd piawg

cargo build --release

cp ./target/release/piawg /dest/path/

```

---

## Library

TODO(fnichol): fill in

### Usage

This crate is on [crates.io](https://crates.io/crates/piawg) and can be used by

adding the crate to your dependencies in your project's `Cargo.toml` file:

```toml

[dependencies]

piawg = { version = "0.1.0", default-features = false }

```

Note that the default features include dependencies which are required to build

a CLI and are not needed for the library.

### Examples

## CI Status

### Build (main branch)

| Operating System | Target                        | Stable Rust                                                                     |

| ---------------: | ----------------------------- | ------------------------------------------------------------------------------- |

|          FreeBSD | `x86_64-unknown-freebsd`      | [![FreeBSD Build Status][badge-ci-build-x86_64-unknown-freebsd]][ci-staging]    |

|            Linux | `arm-unknown-linux-gnueabihf` | [![Linux Build Status][badge-ci-build-arm-unknown-linux-gnueabihf]][ci-staging] |

|            Linux | `aarch64-unknown-linux-gnu`   | [![Linux Build Status][badge-ci-build-aarch64-unknown-linux-gnu]][ci-staging]   |

|            Linux | `i686-unknown-linux-gnu`      | [![Linux Build Status][badge-ci-build-i686-unknown-linux-gnu]][ci-staging]      |

|            Linux | `i686-unknown-linux-musl`     | [![Linux Build Status][badge-ci-build-i686-unknown-linux-musl]][ci-staging]     |

|            Linux | `x86_64-unknown-linux-gnu`    | [![Linux Build Status][badge-ci-build-x86_64-unknown-linux-gnu]][ci-staging]    |

|            Linux | `x86_64-unknown-linux-musl`   | [![Linux Build Status][badge-ci-build-x86_64-unknown-linux-musl]][ci-staging]   |

|            macOS | `x86_64-apple-darwin`         | [![macOS Build Status][badge-ci-build-x86_64-apple-darwin]][ci-staging]         |

|          Windows | `x86_64-pc-windows-msvc`      | [![Windows Build Status][badge-ci-build-x86_64-pc-windows-msvc]][ci-staging]    |

### Test (main branch)

| Operating System | Stable Rust                                                               | Nightly Rust                                                                |

| ---------------: | ------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

|          FreeBSD | [![FreeBSD Stable Test Status][badge-ci-test-stable-freebsd]][ci-staging] | [![FreeBSD Nightly Test Status][badge-ci-test-nightly-freebsd]][ci-staging] |

|            Linux | [![Linux Stable Test Status][badge-ci-test-stable-linux]][ci-staging]     | [![Linux Nightly Test Status][badge-ci-test-nightly-linux]][ci-staging]     |

|            macOS | [![macOS Stable Test Status][badge-ci-test-stable-macos]][ci-staging]     | [![macOS Nightly Test Status][badge-ci-test-nightly-macos]][ci-staging]     |

|          Windows | [![Windows Stable Test Status][badge-ci-test-stable-windows]][ci-staging] | [![Windows Nightly Test Status][badge-ci-test-nightly-windows]][ci-staging] |

**Note**: The

[Minimum Supported Rust Version (MSRV)](https://github.com/rust-lang/rfcs/pull/2495)

is also tested and can be viewed in the [CI dashboard][ci-staging].

### Check (main branch)

|        | Status                                                |

| ------ | ----------------------------------------------------- |

| Lint   | [![Lint Status][badge-ci-check-lint]][ci-staging]     |

| Format | [![Format Status][badge-ci-check-format]][ci-staging] |

## Code of Conduct

This project adheres to the Contributor Covenant [code of

conduct][code-of-conduct]. By participating, you are expected to uphold this

code. Please report unacceptable behavior to [email protected].

## Issues

If you have any problems with or questions about this project, please contact us

through a [GitHub issue][issues].

## Contributing

You are invited to contribute to new features, fixes, or updates, large or

small; we are always thrilled to receive pull requests, and do our best to

process them as fast as we can.

Before you start to code, we recommend discussing your plans through a [GitHub

issue][issues], especially for more ambitious contributions. This gives other

contributors a chance to point you in the right direction, give you feedback on

your design, and help you find out if someone else is working on the same thing.

## Release History

See the [changelog] for a full release history.

## Authors

Created and maintained by [Fletcher Nichol][fnichol] ().

## License

Licensed under the Mozilla Public License Version 2.0 ([LICENSE.txt][license]).

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the MIT license, shall be

licensed as above, without any additional terms or conditions.

[badge-bors]: https://bors.tech/images/badge_small.svg

[badge-ci-build-x86_64-unknown-freebsd]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-x86_64-unknown-freebsd.tar.gz

[badge-ci-build-arm-unknown-linux-gnueabihf]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-arm-unknown-linux-gnueabihf.tar.gz

[badge-ci-build-aarch64-unknown-linux-gnu]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-aarch64-unknown-linux-gnu.tar.gz

[badge-ci-build-i686-unknown-linux-gnu]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-i686-unknown-linux-gnu.tar.gz

[badge-ci-build-i686-unknown-linux-musl]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-i686-unknown-linux-musl.tar.gz

[badge-ci-build-x86_64-unknown-linux-gnu]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-x86_64-unknown-linux-gnu.tar.gz

[badge-ci-build-x86_64-unknown-linux-musl]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-x86_64-unknown-linux-musl.tar.gz

[badge-ci-build-x86_64-apple-darwin]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-x86_64-apple-darwin.zip

[badge-ci-build-x86_64-pc-windows-msvc]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=build-bin-piawg-x86_64-pc-windows-msvc.zip

[badge-ci-check-format]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=check&script=format

[badge-ci-check-lint]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=check&script=lint

[badge-ci-overall]:

  https://img.shields.io/cirrus/github/fnichol/piawg/main?style=flat-square

[badge-ci-test-nightly-freebsd]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-nightly-x86_64-unknown-freebsd

[badge-ci-test-nightly-linux]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-nightly-x86_64-unknown-linux-gnu

[badge-ci-test-nightly-macos]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-nightly-x86_64-apple-darwin

[badge-ci-test-nightly-windows]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-nightly-x86_64-pc-windows-msvc

[badge-ci-test-stable-freebsd]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-stable-x86_64-unknown-freebsd

[badge-ci-test-stable-linux]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-stable-x86_64-unknown-linux-gnu

[badge-ci-test-stable-macos]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-stable-x86_64-apple-darwin

[badge-ci-test-stable-windows]:

  https://img.shields.io/cirrus/github/fnichol/piawg/staging?style=flat-square&task=test-stable-x86_64-pc-windows-msvc

[badge-crate-dl]: https://img.shields.io/crates/d/piawg.svg?style=flat-square

[badge-docker-pulls]:

  https://img.shields.io/docker/pulls/fnichol/piawg.svg?style=flat-square

[badge-docs]: https://docs.rs/piawg/badge.svg?style=flat-square

[badge-github-dl]:

  https://img.shields.io/github/downloads/fnichol/piawg/total.svg

[badge-license]: https://img.shields.io/crates/l/piawg.svg?style=flat-square

[badge-version]: https://img.shields.io/crates/v/piawg.svg?style=flat-square

[bors-dashboard]: https://app.bors.tech/repositories/35002

[changelog]: https://github.com/fnichol/piawg/blob/main/CHANGELOG.md

[ci]: https://cirrus-ci.com/github/fnichol/piawg

[ci-staging]: https://cirrus-ci.com/github/fnichol/piawg/staging

[code-of-conduct]: https://github.com/fnichol/piawg/blob/main/CODE_OF_CONDUCT.md

[crate]: https://crates.io/crates/piawg

[docker]: https://hub.docker.com/r/fnichol/piawg

[docs]: https://docs.rs/piawg

[fnichol]: https://github.com/fnichol

[github]: https://github.com/fnichol/piawg

[github-releases]: https://github.com/fnichol/piawg/releases

[issues]: https://github.com/fnichol/piawg/issues

[license]: https://github.com/fnichol/piawg/blob/main/LICENSE.txt

[nightly]: https://github.com/fnichol/piawg/releases/tag/nightly
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/fnichol/piawg

Awesome Lists containing this project

README

piawg

TODO(fnichol): fill in
