Skip to content

Commit 1b64465

Browse files
CLOUDP-343976: Adds note on secure stored properties for config edit (#4210)
Co-authored-by: John Williams <[email protected]>
1 parent 6ebb4e2 commit 1b64465

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/command/atlas-config-edit.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Opens the config file with the default text editor.
1616

1717
Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default.
1818

19+
Note: You can't modify authentication credentials directly in the config file if they are stored securely. To view all properties associated with a profile, use "atlas config describe". To modify authentication credentials stored securely, use "atlas config set".
20+
1921
Syntax
2022
------
2123

internal/cli/config/edit.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ func EditBuilder() *cobra.Command {
5454
cmd := &cobra.Command{
5555
Use: "edit",
5656
Short: "Opens the config file with the default text editor.",
57-
Long: `Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default.`,
57+
Long: `Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default.
58+
59+
Note: You can't modify authentication credentials directly in the config file if they are stored securely. To view all properties associated with a profile, use "atlas config describe". To modify authentication credentials stored securely, use "atlas config set".`,
5860
Example: ` # To open the config
5961
atlas config edit
6062
`,

0 commit comments

Comments
 (0)