Skip to content

Commit 27a998d

Browse files
improve help message for profile copy command
1 parent 45d3433 commit 27a998d

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

src/planet_auth_utils/commands/cli/profile_cmd.py

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,13 @@ def cmd_profile_edit():
225225
raise AuthException("Function not implemented")
226226

227227

228-
@cmd_profile.command("copy")
228+
# Separte help since the docstring here is developer oriented, not user oriented.
229+
@cmd_profile.command(
230+
"copy",
231+
help="Copy an existing profile to create a new profile. Only the persistent"
232+
" profile configuration will be copied. User access tokens initialized"
233+
" via a call to `login` will not be copied.",
234+
)
229235
@click.argument("src")
230236
@click.argument("dst")
231237
@opt_sops()
@@ -234,18 +240,20 @@ def cmd_profile_copy(sops, src, dst):
234240
"""
235241
Copy an existing profile to create a new profile. Only the persistent
236242
profile configuration will be copied. User access tokens initialized
237-
via a call to `login` will not be copied. Note: Depending on the
238-
type of [planet_auth.AuthClient] configured in the source profile,
239-
the new profile may have long term credentials (e.g. OAuth
240-
client credential secrets, API keys. etc.). External support files,
241-
such as public/private keypair files, are not copied.
243+
via a call to `login` will not be copied.
244+
245+
Note: Depending on the type of [planet_auth.AuthClient] configured in
246+
the source profile, the new profile may have long term credentials
247+
(e.g. OAuth client credential secrets, API keys. etc.).
248+
249+
Note: External support files, such as public/private keypair files,
250+
are not copied.
242251
243252
This command will work with built-in as well as custom profiles,
244253
so it is possible to bootstrap profiles to manage multiple user
245254
identities with an otherwise default client profile:
246255
```
247-
profile copy default <my_new_profile>
248-
profile copy legacy <my_new_profile>
256+
profile copy my_app_builtin_default <my_new_profile>
249257
```
250258
251259
"""

0 commit comments

Comments
 (0)