Skip to content

fix(cli): use the stellar-scaffold name in help and version output - #636

Merged
chadoh merged 1 commit into
stellar-scaffold:mainfrom
sharmis-tp:docs/596-cli-package-name
Oct 21, 2026
Merged

chadoh merged 1 commit into
stellar-scaffold:mainfrom
sharmis-tp:docs/596-cli-package-name

Conversation

@sharmis-tp

Copy link
Copy Markdown
Contributor

Closes #596

  • stellar scaffold --help listed version as "Version of the scaffold-stellar-cli". It now says stellar-scaffold-cli, the crate's name.
  • stellar scaffold version printed its first line as scaffold <version>, while doctor reports stellar-scaffold <version> and the binary is stellar-scaffold. The first line now reads stellar-scaffold 0.0.30 (...). If you'd rather keep the version output unchanged, I'll drop that line.
  • A unit test checks the version help text and that the top-level help no longer contains the old name.

The old name appears nowhere else in the CLI's help text. cargo test -p stellar-scaffold-cli --lib commands::version, cargo clippy --tests -- -D warnings and cargo fmt --check pass.

Noticed while reading: the build help still describes environments.toml and STELLAR_SCAFFOLD_ENV, which a version 2 scaffold.yml ignores. Happy to update that in a separate PR if useful.

@pselle
pselle requested a review from chadoh October 21, 2026 18:30

@chadoh chadoh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this, thank you!! The build help was updated early today in #637

@chadoh
chadoh merged commit eacfe3c into stellar-scaffold:main Oct 21, 2026
4 checks passed
chadoh pushed a commit that referenced this pull request Oct 23, 2026
## 🤖 New release

* `stellar-scaffold-cli`: 0.0.31 -> 0.0.32 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

##
[0.0.32](stellar-scaffold-cli-v0.0.31...stellar-scaffold-cli-v0.0.32)
- 2026-10-23

### Added

- *(stellar-scaffold-cli)* don't write empty meta
([#640](#640))

### Fixed

- scaffold.yml v2 fast-follows for the 1.0 preview
([#632](#632))
- *(cli)* use the stellar-scaffold name in help and version output
([#636](#636))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

Co-authored-by: aha-release-plz[bot] <211513279+aha-release-plz[bot]@users.noreply.github.com>
@sharmis-tp sharmis-tp mentioned this pull request Oct 28, 2026
1 task done
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.

Update help doc CLI package reference

2 participants