Header Remake is a CLI tool inspired by headers by transmission11
.
This tool generates customizable, visually appealing comment headers for programming files. With options for symbols, length, and format, Header Remake makes it easy to add professional, readable headers to code files.
- Custom Symbols: Style your headers with any symbol (e.g.,
#
for Python,//
for JavaScript). - Adjustable Length: Define the total length of the header line for consistent formatting.
- Single-Line or Boxed Headers: Choose between single-line headers or boxed multi-line headers.
- Clipboard Integration: Automatically copies the generated header to your clipboard for quick pasting.
- Error Handling: Provides helpful error messages for unsupported inputs or clipboard issues.
-
- Clone the repository:
git clone https://github.com/ArshilHapani/Header-remake cd Header-remake
- Build the project:
cargo build --release
- Clone the repository:
-
- Directly download the binary from here or
- Download binary using
curl
:# download the binary (for Linux and macOS) curl -L -o headers https://github.com/ArshilHapani/Header-remake/releases/download/0.1.2/headers-remake # make the binary executable chmod +x headers # copy the binary to a directory in your PATH sudo mv headers /usr/local/bin
Run the headers
command with any of the options below to create a custom header:
headers [OPTIONS] [TITLE]
- TITLE is optional; if omitted, it defaults to "Title."
Option | Description |
---|---|
-s , --symbol |
Set the symbol for the header (default: / ). |
-l , --length |
Set the total length of the header line (default: 50 ). |
-sl , --single-line |
Generate a single-line header instead of a boxed header. |
-h , --help |
Display help information. |
-
Basic Header:
headers "My Project"
Output:
////////////////////////////////////////////////// /////////////////// MY PROJECT /////////////////// //////////////////////////////////////////////////
Creates a 50-character header with the title "MY PROJECT" centered using
/
. -
Custom Symbol and Length:
headers -s "#" -l 60 "My Header"
Output:
############################################################ ######################## MY HEADER ######################## ############################################################
Creates a 60-character header with
#
symbols surrounding "MY HEADER". -
Single-Line Header:
headers -sl -s "//" "Single Line"
Output:
//////////////////////////////////// SINGLE LINE ////////////////////////////////////
Generates a single-line header formatted with
//
symbols.
- Length Too Short: If the specified length is too small to accommodate the title, an error message appears.
- Clipboard Issues: If clipboard access fails, an error message notifies the user.
Latest release can be found here
read the wiki for more information
Contributions are welcome! Please submit issues or create pull requests for improvements or new features.
This project is licensed under the MIT License.
Acknowledgment to the original headers project by transmission11
.