Skip to content

๐Ÿ’ป๐Ÿ–Œ๏ธ Add headers with metadata and ASCII art to your code files

License

Notifications You must be signed in to change notification settings

marsdevx/ascii2header

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

51 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Logo ASCII header

Last Commit Shell Support
Languages Header Generator Customizable

๐Ÿ–Œ๏ธ ASCII to Header

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!


๐Ÿ–ผ๏ธ Preview

Preview

๐Ÿ› ๏ธ Installation

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.
  1. Clone repo
git clone https://github.com/marsdevx/ascii2header.git ~/ascii2header
  1. Install Python
brew install python
  1. 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

๐Ÿš€ Usage

  1. Add a Header to a Single File
ascii2header <file>
  1. Add Headers to All Files in a Directory
ascii2header <dir>
  1. Add Headers to Multiple Files and Directories
ascii2header <dir> <file> <dir> <file> <file>
  1. Specify ASCII Art
ascii2header <file> -a <ascii>
  • Available ASCII Art Options
    • anime-girl
    • asteroid
    • cat
    • eye
    • eyes
    • franxx
    • gary
    • gojo
    • pikachu
    • rabbit

โš™๏ธ Advanced Options

Add Your Own ASCII Art

  1. Navigate to the ASCII Arts Directory
cd ~/ascii2header/ascii-arts
  1. Add ASCII Art
  • Create a new file inside the ascii-arts directory.
  • Paste your custom ASCII art into the file and save it.

๐Ÿ“‹ License

All the code contained in this repo is licensed under the MIT License

MIT License

Copyright (c) 2025 marsdevx

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.