Skip to content

Add --non-interactive flag and improve TTY detection #1553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tashian wants to merge 8 commits into
base: master
Choose a base branch
from
+98 −32
Open

Add --non-interactive flag and improve TTY detection #1553

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2418bad
Add --non-interactive flag and improve TTY detection
tashian Jan 22, 2026
095867f
Merge branch 'master' into carl/tty-detection-674
tashian Jan 27, 2026
b119584
Don't hardcode password flag in non-interactive error
tashian Jan 27, 2026
ed500cc
Propagate --non-interactive flag to environment variable
tashian Jan 27, 2026
5795a14
Remove error param
tashian Jan 27, 2026
8676497
More specific hints when using non-interactive mode
tashian Jan 27, 2026
f98fc9d
Merge branch 'master' into carl/tty-detection-674
tashian Jan 27, 2026
c5454ee
Remove unused errs import and local replace directive
tashian Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ require (
go.opentelemetry.io/otel/metric v1.38.0 // indirect
go.opentelemetry.io/otel/trace v1.38.0 // indirect
go.yaml.in/yaml/v2 v2.4.2 // indirect
golang.org/x/net v0.48.0 // indirect
golang.org/x/net v0.49.0 // indirect
golang.org/x/oauth2 v0.33.0 // indirect
golang.org/x/sync v0.19.0 // indirect
golang.org/x/text v0.33.0 // indirect
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,8 +402,8 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
golang.org/x/net v0.48.0 h1:zyQRTTrjc33Lhh0fBgT/H3oZq9WuvRR5gPC70xpDiQU=
golang.org/x/net v0.48.0/go.mod h1:+ndRgGjkh8FGtu1w1FGbEC31if4VrNVMuKTgcAAnQRY=
golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o=
golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8=
golang.org/x/oauth2 v0.33.0 h1:4Q+qn+E5z8gPRJfmRy7C2gGG3T4jIprK6aSYgTXGRpo=
golang.org/x/oauth2 v0.33.0/go.mod h1:lzm5WQJQwKZ3nwavOZ3IS5Aulzxi68dUSgRHujetwEA=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
Expand Down
14 changes: 14 additions & 0 deletions internal/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"github.com/urfave/cli"

"github.com/smallstep/cli-utils/command"
"github.com/smallstep/cli-utils/errs"
"github.com/smallstep/cli-utils/fileutil"
"github.com/smallstep/cli-utils/step"
"github.com/smallstep/cli-utils/ui"
Expand Down Expand Up @@ -96,9 +97,15 @@
// Define default file writers and prompters for go.step.sm/crypto
pemutil.WriteFile = fileutil.WriteFile
pemutil.PromptPassword = func(msg string) ([]byte, error) {
if !ui.CanPrompt() {

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / govulncheck / govulncheck 

undefined: ui.CanPrompt

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / lint / lint 

undefined: ui.CanPrompt

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / codeql / CodeQL Analyze (go) 

undefined: ui.CanPrompt

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (oldstable) 

undefined: ui.CanPrompt

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (stable) 

undefined: ui.CanPrompt

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (stable) 

undefined: ui.CanPrompt

Check failure on line 100 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (oldstable) 

undefined: ui.CanPrompt
return nil, errs.NewRequiredInputError("password", "password-file")

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / govulncheck / govulncheck 

undefined: errs.NewRequiredInputError

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / lint / lint 

undefined: errs.NewRequiredInputError

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / codeql / CodeQL Analyze (go) 

undefined: errs.NewRequiredInputError

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (oldstable) 

undefined: errs.NewRequiredInputError

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (stable) 

undefined: errs.NewRequiredInputError

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (stable) 

undefined: errs.NewRequiredInputError

Check failure on line 101 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (oldstable) 

undefined: errs.NewRequiredInputError
Copy link
Member

@hslatman hslatman Jan 26, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

This could be confusing if the flag / file is different for a specific command. I believe password and password-file will work for most cases, and it's certainly better than what we do today, but there can be edge cases requiring different fields. It's possible this approach works for all uses of pemutil.PromptPassword and jose.PromptPassword, but it'd be best if the changes incli-utils can also accomodate other use cases.

It would be better if the actual flag/file were passed based on (the context of) the command that is being executed. Also see #688, which was stuck on passing that.

Copy link
Contributor Author

@tashian tashian Jan 27, 2026

Choose a reason for hiding this comment

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

I think I was able to address what you're asking for here, @hslatman, but take a look. It's definitely a bigger PR but the error messages are more contextually helpful now.

}
return ui.PromptPassword(msg)
}
jose.PromptPassword = func(msg string) ([]byte, error) {
if !ui.CanPrompt() {

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / govulncheck / govulncheck 

undefined: ui.CanPrompt

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / lint / lint 

undefined: ui.CanPrompt

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / codeql / CodeQL Analyze (go) 

undefined: ui.CanPrompt

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (oldstable) 

undefined: ui.CanPrompt

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (stable) 

undefined: ui.CanPrompt

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (stable) 

undefined: ui.CanPrompt

Check failure on line 106 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (oldstable) 

undefined: ui.CanPrompt
return nil, errs.NewRequiredInputError("password", "password-file")

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / govulncheck / govulncheck 

undefined: errs.NewRequiredInputError

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / lint / lint 

undefined: errs.NewRequiredInputError (typecheck)

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / codeql / CodeQL Analyze (go) 

undefined: errs.NewRequiredInputError

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (oldstable) 

undefined: errs.NewRequiredInputError

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / test / test (stable) 

undefined: errs.NewRequiredInputError

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (stable) 

undefined: errs.NewRequiredInputError

Check failure on line 107 in internal/cmd/root.go

View workflow job for this annotation

GitHub Actions / ci / build / build (oldstable) 

undefined: errs.NewRequiredInputError
}
return ui.PromptPassword(msg)
}

Expand Down Expand Up @@ -130,6 +137,13 @@
Usage: "path to the config file to use for CLI flags",
})

// Flag to disable interactive prompts
app.Flags = append(app.Flags, cli.BoolFlag{
Name: "non-interactive",
Usage: "disable interactive prompts; commands will fail if required input is missing",
EnvVar: "STEP_NON_INTERACTIVE",
})

// Action runs on `step` or `step <command>` if the command is not enabled.
app.Action = func(ctx *cli.Context) error {
args := ctx.Args()
Expand Down
Loading