Skip to content

Commit

Permalink
Add explainer text to sgr engine add
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
onpaws authored and mildbyte committed Jul 23, 2022
1 parent ec4904c commit 34fec11
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion splitgraph/commandline/engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,9 @@ def _update_bar(
"--cap-add", help="Add kernel capabilities to the engine container", multiple=True, default=[]
)
@click.argument("name", default=DEFAULT_ENGINE)
@click.password_option()
@click.password_option(
prompt="Enter a password to protect your local engine. \nWill be saved to .sgconfig (usually ~/.splitgraph/.sgconfig)\nPassword"
)
def add_engine_c(
image,
port,
Expand Down

0 comments on commit 34fec11

Please sign in to comment.