This project is a command-line tool designed to add customizable headers to your code files with ASCII art and file information. Built with Python, this lightweight and open-source program makes it easy to personalize your files and add a professional touch.
- Custom ASCII art to make your headers visually unique.
- Automatically adds file-specific metadata.
- Built with Python for simplicity and cross-platform compatibility.
- A great tool for developers who want to enhance the readability and branding of their code files.
Add style and structure to your code with this powerful and flexible header generator!
To install this project, Launch the Terminal app on your system, and run the commands below.
- If a pop-up appears prompting you to download the Xcode Command Line Tools after the first command, click โDownloadโ and then run the first command again.
- Clone repo
git clone https://github.com/marsdevx/ascii2header.git ~/ascii2header
- Install Python
brew install python
- Set Up an Alias
- For Zsh Users
echo "\nalias ascii2header=\"python3 /Users/$(whoami)/ascii2header/ascii2header.py\"" >> ~/.zshrc
source ~/.zshrc
- For Bash Users:
echo "\nalias ascii2header=\"python3 /Users/$(whoami)/ascii2header/ascii2header.py\"" >> ~/.bashrc
source ~/.bashrc
- Add a Header to a Single File
ascii2header <file>
- Add Headers to All Files in a Directory
ascii2header <dir>
- Add Headers to Multiple Files and Directories
ascii2header <dir> <file> <dir> <file> <file>
- Specify ASCII Art
ascii2header <file> -a <ascii>
- Available ASCII Art Options
anime-girl
asteroid
cat
eye
eyes
franxx
gary
gojo
pikachu
rabbit
- Navigate to the ASCII Arts Directory
cd ~/ascii2header/ascii-arts
- Add ASCII Art
- Create a new file inside the ascii-arts directory.
- Paste your custom ASCII art into the file and save it.