Change: hztool rename to hazaar #335

New issue

Closed

opened 2025-04-04 00:07:46 +00:00 by jamie · 4 comments

jamie commented

2025-04-04 00:07:46 +00:00

(Migrated from git.hazaar.io)

Problem Statement

The current CLI tool for Hazaar is named hztool, which is less intuitive and inconsistent with the framework's branding. This can lead to confusion for new users and breaks naming consistency across tools and documentation.

Who will benefit?

All developers using the Hazaar framework.
New adopters looking for consistent and intuitive tooling.
CI/CD pipeline maintainers who want consistent naming in scripts.

Benefits and risks

Benefits:

Improves clarity and brand consistency by aligning the CLI tool name with the framework.
Easier to remember and use.
Reduces confusion in documentation and onboarding processes.
Follows naming conventions similar to other frameworks (e.g., symfony, artisan, rails).

Risks:

May break existing scripts or documentation that use hztool.
Users may need to update Dockerfiles, shell scripts, and CI configurations.

Proposed solution

Rename the CLI tool from hztool to hazaar. Update:

All internal references to the binary.
Documentation, README files, and examples.
CI/CD templates and published containers (if applicable).

Examples

Laravel uses artisan.
Symfony uses symfony.
Rails uses rails.

Priority/Severity

High (This will bring a huge increase in performance/productivity/usability/legislative cover)
Medium (This will bring a good increase in performance/productivity/usability)
Low (anything else e.g., trivial, minor improvements)

## Problem Statement The current CLI tool for Hazaar is named `hztool`, which is less intuitive and inconsistent with the framework's branding. This can lead to confusion for new users and breaks naming consistency across tools and documentation. ## Who will benefit? - All developers using the Hazaar framework. - New adopters looking for consistent and intuitive tooling. - CI/CD pipeline maintainers who want consistent naming in scripts. ## Benefits and risks ### Benefits: - Improves clarity and brand consistency by aligning the CLI tool name with the framework. - Easier to remember and use. - Reduces confusion in documentation and onboarding processes. - Follows naming conventions similar to other frameworks (e.g., `symfony`, `artisan`, `rails`). ### Risks: - May break existing scripts or documentation that use `hztool`. - Users may need to update Dockerfiles, shell scripts, and CI configurations. ## Proposed solution Rename the CLI tool from `hztool` to `hazaar`. Update: - All internal references to the binary. - Documentation, README files, and examples. - CI/CD templates and published containers (if applicable). ## Examples - Laravel uses `artisan`. - Symfony uses `symfony`. - Rails uses `rails`. ## Priority/Severity - [x] High (This will bring a huge increase in performance/productivity/usability/legislative cover) - [ ] Medium (This will bring a good increase in performance/productivity/usability) - [ ] Low (anything else e.g., trivial, minor improvements)

jamie commented

2025-04-04 00:07:46 +00:00

(Migrated from git.hazaar.io)

assigned to @jamie