2.4 KiB

Raw Blame History

term-header

term-header is a Rust-based command-line tool that generates customizable ASCII art terminal headers. These headers can be added to your .bashrc or other startup files to personalize the appearance of your terminal each time it starts.

Features

Customizable Headers: Use ASCII art files to create unique headers.
Color Options: Specify text color for your headers (note that terminal themes may cause unexpected behavior).
Flexible Paths: Configure paths for titles, art, and banners.

Installation

From Source

Ensure you have Rust installed. If not, you can install it from rust-lang.org.
Clone the repository:

git clone https://vcs.r0r-5chach.xyz/r0r-5chach/term-header.git
cd term-header

Build the project:

cargo build --release

Optionally, install the binary globally:

cargo install --path .

Using Pre-built Binaries

Check the Releases page for pre-built binaries.

Usage

Run term-header with the following options:


term-header [OPTIONS]

Options

    -t, --titles-path <TITLES_PATH>
    The path to the ASCII text files directory (default: ./titles/).

    -a, --art-path <ART_PATH>
    The path to the ASCII image files directory (default: ./art/).

    -b, --banner-path <BANNER_PATH>
    The path to the ASCII banner (default: ./banner.txt).

    -c, --color <COLOR>
    The color the text should be outputted as. Note that terminal themes can cause unexpected behavior.

    -h, --help
    Print help information.

    -V, --version
    Print the version number.

Examples

Add a simple header to your terminal startup by configuring your .bashrc:


# Add this line to your .bashrc
term-header -t ./path/to/titles/ -a ./path/to/art/ -b ./path/to/banner.txt -c green

Contributing

Contributions are welcome! If you have suggestions, issues, or feature requests, please open an issue or submit a pull request.

Fork the repository.
Create a new branch (git checkout -b feature/your-feature).
Make your changes.
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin feature/your-feature).
Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

2.4 KiB Raw Blame History