Skip to content

docs(automq-shell): fix build and run instructions - #3524

Open
hachiwar wants to merge 1 commit into
AutoMQ:mainfrom
hachiwar:codex/docs-automq-shell
Open

docs(automq-shell): fix build and run instructions#3524
hachiwar wants to merge 1 commit into
AutoMQ:mainfrom
hachiwar:codex/docs-automq-shell

Conversation

@hachiwar

Copy link
Copy Markdown
Contributor

Why

The AutoMQ CLI README points to the unrelated :cli project and tries to run its thin JAR with java -jar. The documented native-image command uses the same incorrect artifact.

What

  • build the repository's existing release distribution
  • run AutoMQ CLI through bin/automq-cli.sh
  • clarify that :automq-shell:jar is a thin JAR

How

This follows the existing :core:releaseTarGz packaging task, which includes the AutoMQ shell JAR and its runtime dependencies.

Reviewer notes

Documentation-only change. No build logic or runtime behavior changes.

Testing

  • ./gradlew help --task releaseTarGz (passed; resolves to :core:releaseTarGz)
  • ./gradlew releaseTarGz (not completed within the local 120-second verification window)

@CLAassistant

CLAassistant commented Aug 14, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@hachiwar
hachiwar marked this pull request as ready for review August 14, 2026 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants