|
| 1 | +# RSP (Raw String Peeler) |
| 2 | + |
| 3 | +A Rust CLI tool that converts escaped strings embedded in YAML ConfigMaps into properly formatted multi-line strings using YAML's pipe (`|`) syntax. |
| 4 | + |
1 | 5 | <!-- START doctoc generated TOC please keep comment here to allow auto update --> |
2 | 6 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
3 | 7 | ## Table of Contents |
4 | 8 |
|
5 | | -- [RSP (Raw String Peeler)](#rsp-raw-string-peeler) |
6 | | - - [Table of Contents](#table-of-contents) |
7 | | - - [Installation](#installation) |
8 | | - - [From Source](#from-source) |
9 | | - - [Prerequisites](#prerequisites) |
10 | | - - [Get Started](#get-started) |
11 | | - - [Basic Usage](#basic-usage) |
12 | | - - [What it does](#what-it-does) |
13 | | - - [Supported file types](#supported-file-types) |
14 | | - - [Testing](#testing) |
15 | | - - [CI/CD](#cicd) |
16 | | - - [License](#license) |
17 | | - - [Contribution](#contribution) |
18 | | - - [Project Structure](#project-structure) |
| 9 | +- [Installation](#installation) |
| 10 | + - [From Source](#from-source) |
| 11 | + - [Prerequisites](#prerequisites) |
| 12 | +- [Get Started](#get-started) |
| 13 | + - [Basic Usage](#basic-usage) |
| 14 | +- [What it does](#what-it-does) |
| 15 | +- [Supported file types](#supported-file-types) |
| 16 | +- [Testing](#testing) |
| 17 | +- [CI/CD](#cicd) |
| 18 | +- [License](#license) |
| 19 | +- [Contribution](#contribution) |
| 20 | + - [Project Structure](#project-structure) |
19 | 21 |
|
20 | 22 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> |
21 | 23 |
|
22 | | -# RSP (Raw String Peeler) |
23 | | - |
24 | | -A Rust CLI tool that converts escaped strings embedded in YAML ConfigMaps into properly formatted multi-line strings using YAML's pipe (`|`) syntax. |
25 | | - |
26 | | -## Table of Contents |
27 | | - |
28 | 24 | ## Installation |
29 | 25 |
|
30 | 26 | ### From Source |
@@ -55,12 +51,17 @@ cargo install --path . |
55 | 51 |
|
56 | 52 | Process a YAML ConfigMap file and output to stdout: |
57 | 53 | ```bash |
58 | | -rsp input.yaml |
| 54 | +rsp peel input.yaml |
59 | 55 | ``` |
60 | 56 |
|
61 | 57 | Process a file and save to output file: |
62 | 58 | ```bash |
63 | | -rsp input.yaml -o output.yaml |
| 59 | +rsp peel input.yaml -o output.yaml |
| 60 | +``` |
| 61 | + |
| 62 | +Process a file from pipe: |
| 63 | +```bash |
| 64 | +cat input.yaml |rsp peel |
64 | 65 | ``` |
65 | 66 |
|
66 | 67 | ## What it does |
|
0 commit comments