Skip to content

Commit 3ae49e8

Browse files
Merge branch 'main' into carl/feedback-1b--login-command-ergonomics
2 parents 3a3d065 + fe78e93 commit 3ae49e8

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
@@ -219,7 +219,13 @@ def cmd_profile_edit():
219219
raise AuthException("Function not implemented")
220220

221221

222-
@cmd_profile.command("copy")
222+
# Separte help since the docstring here is developer oriented, not user oriented.
223+
@cmd_profile.command(
224+
"copy",
225+
help="Copy an existing profile to create a new profile. Only the persistent"
226+
" profile configuration will be copied. User access tokens initialized"
227+
" via a call to `login` will not be copied.",
228+
)
223229
@click.argument("src")
224230
@click.argument("dst")
225231
@opt_sops()
@@ -228,18 +234,20 @@ def cmd_profile_copy(sops, src, dst):
228234
"""
229235
Copy an existing profile to create a new profile. Only the persistent
230236
profile configuration will be copied. User access tokens initialized
231-
via a call to `login` will not be copied. Note: Depending on the
232-
type of [planet_auth.AuthClient] configured in the source profile,
233-
the new profile may have long term credentials (e.g. OAuth
234-
client credential secrets, API keys. etc.). External support files,
235-
such as public/private keypair files, are not copied.
237+
via a call to `login` will not be copied.
238+
239+
Note: Depending on the type of [planet_auth.AuthClient] configured in
240+
the source profile, the new profile may have long term credentials
241+
(e.g. OAuth client credential secrets, API keys. etc.).
242+
243+
Note: External support files, such as public/private keypair files,
244+
are not copied.
236245
237246
This command will work with built-in as well as custom profiles,
238247
so it is possible to bootstrap profiles to manage multiple user
239248
identities with an otherwise default client profile:
240249
```
241-
profile copy default <my_new_profile>
242-
profile copy legacy <my_new_profile>
250+
profile copy my_app_builtin_default <my_new_profile>
243251
```
244252
245253
"""

0 commit comments

Comments
 (0)