# auto-copyright-protect

<div align="center">
  <img src="assets/logo.png" alt="auto-copyright-protect Logo" width="200"/>
  <br/>
  <h1>auto-copyright-protect</h1>
  <p><strong>Effortless copyright compliance for every line of code.</strong></p>
  <a href="https://github.com/AshrafMorningstar/auto-copyright-protect"><img src="https://img.shields.io/github/stars/AshrafMorningstar/auto-copyright-protect?style=flat-square" alt="Stars"/></a>
  <a href="https://github.com/AshrafMorningstar/auto-copyright-protect/blob/main/LICENSE"><img src="https://img.shields.io/github/license/AshrafMorningstar/auto-copyright-protect?style=flat-square" alt="License"/></a>
</div>

---

## 🔥 Why This Project?

*Ever spent hours hunting down missing copyright headers?*  
`auto-copyright-protect` turns that nightmare into a **single command**.  
- **Viral‑ready**: Shareable CLI that spreads through dev teams like wildfire.  
- **SEO‑optimized**: Every generated file includes meta‑friendly headers that improve discoverability on code search engines.  
- **Built for learning**: Perfect for students and pros who want to see real‑world automation in action.

---

## ✨ Key Features

- **One‑liner execution** – `npx auto-copyright-protect ./src` scans and updates instantly.  
- **Multi‑language support** – JavaScript, Python, TypeScript, HTML, CSS and more.  
- **Customizable templates** – Define your own header style via `config.json`.  
- **Dry‑run mode** – Preview changes before they touch your repo.  
- **Git‑aware** – Skips already‑tracked files and respects `.gitignore`.  
- **Built‑in reporting** – Generates a `copyright-report.html` summarizing actions.  

---

## 🚀 Installation & Usage

### Prerequisites
- Node.js **>= 18** (or use the bundled Docker image).  
- Optional: Python 3.9+ if you plan to run the `.py` helper scripts.

### Install via npm (global)

```bash
npm install -g auto-copyright-protect

Quick start (CLI)

# Scan the entire project and apply default headers
auto-copyright-protect .

# Dry‑run to see what would change
auto-copyright-protect ./src --dry-run

# Use a custom template
auto-copyright-protect ./src --template ./my-header.txt

Using the Python helper (for legacy pipelines)

python3 assets/auto_apply_copyright.py --path ./src --template ./my-header.txt

Docker alternative

docker run --rm -v "$(pwd)":/app ghcr.io/ashrafmorningstar/auto-copyright-protect:latest ./src

Contributing

1. Fork the repo.
2. Create a feature branch (git checkout -b feat/awesome).
3. Follow the guidelines in CONTRIBUTING.md.
4. Submit a pull request – we’ll review it within 48 hours.

For detailed API reference, see API_REFERENCE.md.

---

🌐 Search Engine Optimization (SEO) Keywords

auto copyright protect, copyright automation, code compliance tool, nodejs cli copyright, python copyright script, open source asset management, seo friendly code headers, developer productivity, learning automation, viral dev tools

---

Made with ❤️ by Ashraf Morningstar – empowering developers to stay compliant while keeping their projects discoverable.