stackabletech / stackabletech/stackablectl

feat: Add option to hide help text at the end

Open
#308 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
10
Forks
5
Avg merge
4h 41m
Merged PRs (30d)
4

Description

It can be a little confusing when running stackablectl within scripts. The help text can look like a command didn't run correctly, when it did and the help text is suggesting what to do next:

Help text

We could either add an option to disable the help text, or just hide it if CI=true (which we can then export in the getting_started.sh scripts).

For reference, Terraform uses an env var TF_IN_AUTOMATION to control the help text output.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating where stackablectl emits the trailing help text and how its CLI options or environment variables are handled. Compare the proposed explicit option and CI-based behavior with Terraform's TF_IN_AUTOMATION reference; done means the chosen automation behavior suppresses the misleading help text without affecting normal interactive output, with getting_started.sh updated if that approach is selected.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.