honeybadgr 0.1.0

CLI utility to create badge-style svg images.
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

# honeybadgr

[![pipeline status](https://gitlab.com/ngreese/honeybadgr/badges/main/pipeline.svg)](https://gitlab.com/ngreese/honeybadgr/-/commits/main)

[![coverage report](https://gitlab.com/ngreese/honeybadgr/badges/main/coverage.svg)](https://gitlab.com/ngreese/honeybadgr/-/commits/main)

[![Latest Release](https://gitlab.com/ngreese/honeybadgr/-/badges/release.svg)](https://gitlab.com/ngreese/honeybadgr/-/releases)

Simple utility used to generate badge svg files.

## Table of Contents

[[_TOC_]]

## Introduction

> [!note]
> The structure and functions for most of the badge module have been inspired by the [badgers crate](https://crates.io/crates/badgers). This crate made changes to enable usage within a binary.

## Installation

To install this binary you can follow the following steps based on your use-case.

### Install from crates.io

On a host with the Rust toolchain installed with `crates.io` configured as your registry, run:

```shell
cargo install honeybadgr
honeybadgr -V
```

### Build from Source

You can build the binary from source by performing the following commands:

```shell
git clone git@gitlab.com:ngreese/honeybadgr.git
cd ./honeybadgr
# If you only want to run the program using cargo
cargo run -- <ARGS>
# If you want to build the release binary and copy it to your bin directory.
cargo build --release
cp target/release/honeybadgr /usr/local/bin # or any other location in your $PATH
```

## Usage

The below snippet contains the programs flags with their respective descriptions, arguments, and defaults.

```shell
Usage: honeybadgr [OPTIONS]

Options:
  -o, --out-file <OUT_FILE>
          Path to the output file [default: ./honeybadgr.svg]
  -k, --key-text <KEY_TEXT>
          Text to use in the 'key' portion of the badge [default: honeybadgr]
      --key-color <KEY_COLOR>
          Color of the 'key' portion of the badge. Must be a hexadecimal value (e.g. #RRGGBB) [default: #5d5d5d]
      --key-font-color <KEY_FONT_COLOR>
          Color of the 'key' portions text. Must be a hexadecimal value (e.g. #RRGGBB) [default: #eaeaea]
  -v, --value-text <VALUE_TEXT>
          Text to use in the 'value' portion of the badge [default: "don't care"]
      --value-color <VALUE_COLOR>
          Color of the 'value' portion of the badge. Must be a hexadecimal value (e.g. #RRGGBB) [default: #a0a0a0]
      --value-font-color <VALUE_FONT_COLOR>
          Color of the 'value' portions text. Must be a hexadecimal value (e.g. #RRGGBB) [default: #eaeaea]
      --font <FONT>
          Path to a ttf font file to use in the generated badge [default: /home/ngreese/workspace/rust/honeybadgr/assets/DejaVuSans.ttf]
  -h, --help
          Print help
  -V, --version
          Print version
```