repvar

Crates.iorepvar
lib.rsrepvar
version0.13.2
sourcesrc
created_at2021-08-03 15:36:11.821826
updated_at2024-06-01 10:32:56.727311
description A tiny CLI tool that replaces variables of the style `${KEY}` in text with their respective value. It can also be used as a rust library.
homepagehttps://github.com/hoijui/repvar
repositoryhttps://github.com/hoijui/repvar
max_upload_size
id430982
size187,224
(hoijui)

documentation

README

repvar - Variable replacing, UNIX-style text filter

License: AGPL-3.0-or-later REUSE status Repo Package Releases Documentation Releases Dependency Status Build Status

In cooperation with FabCity Hamburg In cooperation with Open Source Ecology Germany

A tiny CLI tool that replaces variables of the style ${KEY} in text with their respective value. It can also be used as a rust library.

For the CLI tool, the variables can be read from the environment or be directly supplied through CLI switches, like -Dkey=value.

NOTE
The author is a rust-newb. This crate probably only makes sense for himself, and it is not using the power of rust as should be. It also could probably be written in just 10 lines of code, using one or two regexes, not loosing any performance.

Usage

Simplisitc

$ export KEY_A="replacement"   # setting an env.-variable
$ echo 'Text ${KEY_A}.' \      # input text
    | repvar --env             # replacing variables
Text replacement.              # output

Slightly more elaborate

$ export first="the environment"
$ echo 'Variables from ${first}, ${second}, ${not_supplied} and $${quoted}.' \
    | repvars --env -D"second=the CLI"
Variables from the environment, the CLI, ${not_supplied} and ${quoted}.

More usage info can be seen when running:

repvars --help

Building

# To get a binary for your system
cargo build --release

# To get a 64bit binary that is portabel to all Linux systems
scripts/build

Testing

To run unit-, doc- and integration-tests:

scripts/test

Similar projects

Funding

This project was funded by the European Regional Development Fund (ERDF) in the context of the INTERFACER Project, from August 2021 (project start) until March 2023.

Logo of the EU ERDF program

Commit count: 216

cargo fmt