Skip to content

Commit 34fec11

Browse files
onpawsmildbyte
authored andcommitted
Add explainer text to sgr engine add
As an "impatient onboarder" it wasn't immediately obvious to me the implications of `sgr engine add` prompting for a password. I first suspected `sgr` wanted root and believed it was a sudo prompt. It seems reasonable to add some explainer text here, so as to assuage any worries/confusion as to which password is expected/how it gets used.
1 parent ec4904c commit 34fec11

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

splitgraph/commandline/engine.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,9 @@ def _update_bar(
202202
"--cap-add", help="Add kernel capabilities to the engine container", multiple=True, default=[]
203203
)
204204
@click.argument("name", default=DEFAULT_ENGINE)
205-
@click.password_option()
205+
@click.password_option(
206+
prompt="Enter a password to protect your local engine. \nWill be saved to .sgconfig (usually ~/.splitgraph/.sgconfig)\nPassword"
207+
)
206208
def add_engine_c(
207209
image,
208210
port,

0 commit comments

Comments
 (0)