[BUG] Docs reference nonexistent --use-new-generator flag in AsyncAPI/Generator/Usage

[Jatin24062005]

Describe the bug.

While following the AsyncAPI documentation, I ran the following command exactly as documented:

asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@3.0.0 \
  --use-new-generator \
  -o ./Test \
  docs \
  -d generate:before generate:after=foo,bar

it throwing an error Error: Nonexistent flag: --use-new-generator

Expected behavior

It should work Proper or there must be no mentioned flag in docs https://www.asyncapi.com/docs/tools/generator/usage#cli-usage-examples

Screenshots

How to Reproduce

1. follow this https://www.asyncapi.com/docs/tools/generator/usage#cli-usage-examples
2. Run disabling hook Command

🖥️ Device Information [optional]

• Operating System (OS):
• Browser:
• Browser Version:

👀 Have you checked for similar open issues?

• I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

• I have read the Contributing Guidelines

Are you willing to work on this issue ?

Yes I am willing to submit a PR!

[dosubot]

The --use-new-generator flag is documented and used in official AsyncAPI CLI examples, especially when generating docs with templates like @asyncapi/html-template@3.0.0. However, this flag is not implemented in the generator service itself—it is handled by the AsyncAPI CLI layer. If you run the generator directly (not via the CLI), you'll get an error about the flag being unsupported, which matches what you saw.

If you use the AsyncAPI CLI (not just the generator), the --use-new-generator flag is recognized and required for certain template versions to avoid compatibility issues. The documentation could be clearer about this distinction—right now, it can be confusing if you invoke the generator directly or look for the flag in the generator's own CLI options.

If you want to improve the docs, consider clarifying that --use-new-generator is only supported when using the AsyncAPI CLI, not the generator service directly. This will help others avoid the same confusion. For reference, see the discussion and maintainer comments here and here.

If you still see errors when using the CLI with the flag, they are usually related to environment, permissions, or template installation, not the flag itself.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[Adi-204]

hey @Jatin24062005 the issue is valid and you can proceed to create PR. According to CLI release https://github.com/asyncapi/cli/releases/tag/v5.0.1 the flag is removed. So please remove --use-new-generator flag.

[Jatin24062005]

@Adi-204 I’ve fixed the references in the Generator Library documentation. However, the --use-new-generator flag is also mentioned on the project website.
Would you prefer that I:

• raise a new issue in the Website repo to track this, or
• directly open a new PR there and reference this fix ([BUG] Docs reference nonexistent --use-new-generator flag in AsyncAPI/Generator/Usage #1872) for context?
  I can handle the website update as well to keep everything consistent.

[TaylorSMarks]

I don't know anything about this project - I was just directed to run the command and encountered the bug, so forgive me but,

@Adi-204 - What is the impact of not including --use-new-generator? Was the behavior previously activated by this flag now the default?

Or is the behavior now unavailable and to preserve our workflow we need to pin to an earlier version?

[Adi-204]

@TaylorSMarks --use-new-generator is now the default Generator v3 is the only engine, so just drop the flag and you might need to update some templates version, but should work for majority templates just like before. We changed this as we removed old ag cli from generator. For more ref you can look below -

#1756
asyncapi/cli#1904
asyncapi/cli#1919

If you face any issues while using new cli version to generate template do let us know by opening an issue!

[Adi-204]

closes with #1910