Skip to content

Commit 67bfc8f

Browse files
committed
Update documentation, deprecate aws-keychain env.
`aws-keychain env` is deprecated in favor of `aws-keychain exec`
1 parent 96e86b4 commit 67bfc8f

File tree

2 files changed

+16
-20
lines changed

2 files changed

+16
-20
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@ aws-keychain
22
============
33

44
```
5-
aws-keychain (c) 2014 Paul Annesley MIT license.
5+
aws-keychain (c) 2014-2015 Paul Annesley MIT license.
66
77
Store multiple AWS IAM access keys in Mac OS X keychain.
88
Check out one of them at a time into ~/.aws/credentials
99
1010
Manage access keys in Keychain:
1111
aws-keychain add <name> <access_key_id> <secret_access_key>
12-
aws-keychain cat <name>
13-
aws-keychain env <name>
12+
aws-keychain add <name> # (interactive prompt for key and secret)
1413
aws-keychain ls
15-
aws-keychain none
14+
aws-keychain exec <name> <command ... >
15+
aws-keychain cat <name>
1616
aws-keychain rm <name>
17-
aws-keychain status
1817
aws-keychain use <name>
19-
eval `aws-keychain env <name>`
18+
aws-keychain status
19+
aws-keychain none
2020
```
2121

2222
Install
@@ -53,15 +53,13 @@ $ aws-keychain ls
5353
personal
5454
work
5555
56+
$ aws-keychain exec personal aws s3 ls
57+
5658
$ aws-keychain use personal
5759
5860
$ aws-keychain status
5961
personal: AKILNNK3OPAKMIZRQY1J
6062
61-
$ eval `aws-keychain env work`
62-
$ echo "$AWS_ACCESS_KEY_ID : $AWS_SECRET_ACCESS_KEY"
63-
AKIJA9JFOPAKMH9AJPCJ : LBCoZPXfQNVNRJbwN92pFQ
64-
6563
$ aws-keychain rm work
6664
password has been deleted.
6765

aws-keychain

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
#!/bin/bash
22

3-
## aws-keychain (c) 2014 Paul Annesley MIT license.
3+
## aws-keychain (c) 2014-2015 Paul Annesley MIT license.
44
##
55
## Store multiple AWS IAM access keys in Mac OS X keychain.
66
## Check out one of them at a time into ~/.aws/credentials
77
##
88
## Manage access keys in Keychain:
99
## aws-keychain add <name> <access_key_id> <secret_access_key>
1010
## aws-keychain add <name> # (interactive prompt for key and secret)
11-
## aws-keychain cat <name>
12-
## aws-keychain env <name>
1311
## aws-keychain ls
14-
## aws-keychain none
12+
## aws-keychain exec <name> <command ... >
13+
## aws-keychain cat <name>
1514
## aws-keychain rm <name>
16-
## aws-keychain status
1715
## aws-keychain use <name>
18-
## aws-keychain exec <name> <command ... >
19-
## eval `aws-keychain env <name>`
16+
## aws-keychain status
17+
## aws-keychain none
2018
##
21-
## The `security` CLI to keychain does not enumerate credentials, so
22-
## `aws-keychain ls` is based on an unauthoritative list on disk.
19+
## `aws-keychain ls` is based on an unauthoritative list on disk,
20+
## as the `security` CLI to keychain cannot enumerate credentials.
2321

2422
set -euo pipefail
2523

@@ -30,7 +28,7 @@ main() {
3028
case "${1:-}" in
3129
add) aws_keychain_add "$@" ;;
3230
cat) aws_keychain_cat "$@" ;;
33-
env) aws_keychain_env "$@" ;;
31+
env) aws_keychain_env "$@" ;; # deprecated for external use
3432
exec) aws_keychain_exec "$@" ;;
3533
ls) aws_keychain_ls "$@" ;;
3634
none) aws_keychain_none "$@" ;;

0 commit comments

Comments
 (0)