summaryrefslogtreecommitdiff
path: root/plugins/aws/README.md
diff options
context:
space:
mode:
author0rxa <reiarifi@gmail.com>2024-02-01 17:11:13 +0100
committerGitHub <noreply@github.com>2024-02-01 17:11:13 +0100
commit05bf69c604e34300b02406462d4376c86d595470 (patch)
tree08a9f3ee76fc679f7392f50dd4217d2fe85969ad /plugins/aws/README.md
parent6f215cd6922a76cf8ac6f629d0de386c3eb6667a (diff)
downloadzsh-05bf69c604e34300b02406462d4376c86d595470.tar.gz
zsh-05bf69c604e34300b02406462d4376c86d595470.tar.bz2
zsh-05bf69c604e34300b02406462d4376c86d595470.zip
feat(aws): implement permanent state (#12018)
Co-authored-by: Rei Arifi <reiarifi@Reis-MacBook-Pro.local> Co-authored-by: Hysen Ndregjoni <hndregjoni@hotmail.com>
Diffstat (limited to 'plugins/aws/README.md')
-rw-r--r--plugins/aws/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/plugins/aws/README.md b/plugins/aws/README.md
index dbf8dcfeb..0d0773f63 100644
--- a/plugins/aws/README.md
+++ b/plugins/aws/README.md
@@ -47,6 +47,11 @@ plugins=(... aws)
Some themes might overwrite the value of RPROMPT instead of appending to it, so they'll need to be fixed to
see the AWS profile/region prompt.
+* Set `AWS_PROFILE_STATE_ENABLED=true` in your zshrc file if you want the aws profile to persist between shell sessions.
+ This option might slow down your shell startup time.
+ By default the state file path is `/tmp/.aws_current_profile`. This means that the state won't survive a reboot or otherwise GC.
+ You can control the state file path using the `AWS_STATE_FILE` environment variable.
+
## Theme
The plugin creates an `aws_prompt_info` function that you can use in your theme, which displays