# aki-mcycle
[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
![Rust Version][rustc-image]
![Apache2/MIT licensed][license-image]
the mark up text with cycling color program.
## Features
- mark up text with cycling color.
- minimum support rustc 1.56.1 (59eed8a2a 2021-11-01)
## Command help
```
aki-mcycle --help
```
```
Usage:
aki-mcycle [options]
mark up text with the cyclic color.
Options:
-e, --exp <exp> write it in the cyclic color (default: ' ([0-9A-Z]{3,}):')
-H, --help display this help and exit
-V, --version display version information and exit
Option Parameters:
<exp> regular expression, color the entire match with the cyclic color.
Environments:
AKI_MCYCLE_COLOR_SEQ_RED_ST red start sequence specified by ansi
AKI_MCYCLE_COLOR_SEQ_GREEN_ST green start sequence specified by ansi
AKI_MCYCLE_COLOR_SEQ_BLUE_ST blue start sequence specified by ansi
AKI_MCYCLE_COLOR_SEQ_CYAN_ST cyan start sequence specified by ansi
AKI_MCYCLE_COLOR_SEQ_MAGENDA_ST magenda start sequence specified by ansi
AKI_MCYCLE_COLOR_SEQ_YELLOW_ST yellow start sequence specified by ansi
AKI_MCYCLE_COLOR_SEQ_ED color end sequence specified by ansi
```
## Quick install
1. you can install this into cargo bin path:
```
cargo install aki-mcycle
```
2. you can build debian package:
```
cargo deb
```
and install **.deb** into your local repository of debian package.
## Examples
### Command line example 1
Extract "`arm`" from the rustup target list and make "`linux-[^ ]+`" **color**.
- 1st match: makes '`linux-musl`' **red**
- 2nd match: makes '`linux-musleabi`' **green**
- 3rd match: makes '`linux-musleabihf`' **blue**
- 4th match: makes '`linux-muslabi64`' **cyan**
```
result output :
![out rustup image]
[out rustup image]: https://raw.githubusercontent.com/aki-akaguma/aki-mcycle/main/img/out-rustup-1.png
- [aki-mline](https://crates.io/crates/aki-mline): extract match line command like grep.
## Library example
See [`fn execute()`] for this library examples.
[`fn execute()`]: crate::execute
# Changelogs
[This crate's changelog here.](https://github.com/aki-akaguma/aki-mcycle/blob/main/CHANGELOG.md)
# License
This project is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
https://opensource.org/licenses/MIT)
at your option.
[//]: # (badges)
[crate-image]: https://img.shields.io/crates/v/aki-mcycle.svg
[crate-link]: https://crates.io/crates/aki-mcycle
[docs-image]: https://docs.rs/aki-mcycle/badge.svg
[docs-link]: https://docs.rs/aki-mcycle/
[rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg