gitcraft 0.0.1

A template project for GitHub-related utilities.

Gitcraft (formerly GH Templates)

[!NOTE] This project is currently being renamed and restructured.
Some documentation and package references may still use the old name
gh-templates until the migration is complete.

Gitcraft is a developer-friendly toolkit for managing and applying reusable GitHub repository templates — including Issue Templates, Pull Request Templates, .gitignore files, Licenses, and more.
It helps you quickly scaffold standard project configurations without repetitive manual setup.

---

---

About

Gitcraft is designed to simplify repository setup and management by offering ready-to-use templates and configuration files.
Instead of manually creating .gitignore, license, and issue templates for each new project, Gitcraft helps you generate them instantly from trusted sources.

It works across different ecosystems and supports multiple package managers — Rust (Cargo), Python (PyPI), and Node (npm).

---

Contributing

We welcome contributions from everyone — whether you’re improving templates, fixing docs, or enhancing CLI commands.

Most of the repository consists of:

• YAML files – for GitHub workflows
• Markdown files – for templates & documentation
• License files – for open source compliance

Rust, Python, or Node are only used for the CLI layer, so you can contribute without deep language knowledge.

You can help by:

• Opening issues
• Suggesting new templates
• Improving command UX or documentation

---

Features

• Reusable Templates: Standardized templates for issues, PRs, and licenses.
• CLI Commands: Apply templates quickly via a simple command-line interface.
• Gitignore Management: Add, list, or preview .gitignore templates from the official GitHub source.
• License Templates: Instantly add popular license files (MIT, Apache, GPL, etc.).
• Cross-Platform: Works on Linux, macOS, and Windows.
• Extensible: Designed to support new template categories in the future (like Codes of Conduct, Security Policies, etc.).

---

Installation

Quick Install (Recommended)

Using npm

npm install -g gitcraft

Using pip

pip install gitcraft

Using Cargo

cargo install gitcraft

Example Usage

[!NOTE] Some commands may still appear under the old name gh-templates until the migration is finalized.

New Command Syntax

# Add a Python .gitignore
gitcraft add gitignore python

# List available gitignore templates
gitcraft list gitignores

# Add a bug report issue template
gitcraft add issue-template bug

# Preview a pull request template
gitcraft preview pr-template

# List available licenses
gitcraft list licenses

Old Syntax (Still Supported Temporarily)

gh-templates gitignore add python
gh-templates issue add bug

Migration Notice

• Gitcraft is the next evolution of GH Templates — bringing a cleaner command structure, modern UX, and broader language support.
• You may still see references to gh-templates across:
  • Code imports
  • Package registries (npm, PyPI, crates.io)
  • Docs and badges

These will be updated as the migration completes.

License

• Licensed under the Apache 2.0 License.

---

Key Highlights

• Renamed to Gitcraft, with a clear transition notice.
• Updated badges, usage examples, and command syntax.
• Introduced new natural language CLI syntax (gitcraft add gitignore python).
• Kept backward compatibility note for developers still using gh-templates.

---