aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Segundo2023-04-30 12:44:55 +0200
committerChristian Segundo2023-04-30 12:44:55 +0200
commitf9a6aa553c5780c7579c4a01991e3080d3964706 (patch)
treeff189dd6fc9d54f1bc340ebfe48093a2292f1e81 /README.md
parent0a7759a3caafb085a3578635e2f2b42f66fae7ff (diff)
downloadawscli-plugin-passtotp-f9a6aa553c5780c7579c4a01991e3080d3964706.tar.gz
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 0 insertions, 53 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 358180f..0000000
--- a/README.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# AWS CLI MFA with pass-otp made easy
-
-This plugin enables aws-cli to directly talk to [pass](https://www.passwordstore.org/)
-to acquire an OATH-TOTP code using the [pass-otp](https://github.com/tadfisher/pass-otp) extension.
-
-## Installation
-
-`awscli-plugin-passtotp` can be installed from PyPI:
-```sh
-$ pip install awscli-plugin-passtotp
-```
-
-It's also possible to install it just for your user in case you don't have
-permission to install packages system-wide:
-```sh
-$ pip install --user awscli-plugin-passtotp
-```
-
-### Configure AWS CLI
-
-To enable the plugin, add this to your `~/.aws/config`:
-```ini
-[plugins]
-# If using aws-cli v2 you must specify the path to where the package was installed.
-# Use `pip show awscli-plugin-passtotp | grep Location:` to find the right location.
-cli_legacy_plugin_path = /foo/bar/lib/python3.9/site-packages/
-
-passtotp = awscli_plugin_passtotp
-```
-
-Also make sure to specify a path to a file in your password-store in the profiles managed by pass:
-```ini
-[profile myprofile]
-role_arn = arn:aws:iam::...
-mfa_serial = arn:aws:iam::...
-mfa_path = foo/aws/bar
-...
-```
-
-## Usage
-
-Just use the `aws` command with a custom role and the plugin will do the rest:
-
-```sh
-$ aws s3 ls --profile myprofile
-2013-07-11 17:08:50 mybucket
-2013-07-24 14:55:44 mybucket2
-```
-
----
-
-## Acknowledgements
-* Thanks to [@tommie-lie](https://github.com/tommie-lie) for [awscli-plugin-yubikeytotp](https://github.com/tommie-lie/awscli-plugin-yubikeytotp)