From 76acfb1997293b390cf1795cdb394c9b186b1fad Mon Sep 17 00:00:00 2001 From: un0tec <55037574+un0tec@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:04:31 +0100 Subject: [PATCH 1/2] docs: update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8824fdf..436a5a0 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ ## # Description -`awssopilot` is a command-line tool that automates AWS SSO login for multiple profiles. It supports various login methods such as email/password, phone call, or app-based verification. Additionally, it integrates with [yawsso](https://github.com/victorskl/yawsso) to configure IAM roles once the login process is completed. +`awssopilot` is a command-line tool that automates AWS SSO login for multiple profiles. It supports various login methods such as email/password, phone call, or app-based verification. Additionally, it integrates with [yawsso](https://github.com/victorskl/yawsso) to configure IAM credentials once the login process is completed. ## # Before Running @@ -66,4 +66,4 @@ We welcome contributions to improve the functionality of `awssopilot`! Here's ho Your contributions will be greatly appreciated! -:star: Feel free to contribute :star: \ No newline at end of file +:star: Feel free to contribute :star: From 4c311f49fcc69c48c13fe7da6b9b3d042922b630 Mon Sep 17 00:00:00 2001 From: un0tec <55037574+un0tec@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:13:43 +0100 Subject: [PATCH 2/2] docs: add examples to README.md --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 436a5a0..b120e25 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,54 @@ N/A ## # Examples -N/A +Linux: `~/awssopilot-config`\ +Windows: `%userprofile%/awssopilot-config` + +``` +{ + "profiles": [ + "profile1", + "profile2", + "profile3" + ], + "email": "email@example.com", + "password": "password", + "type": "call", + "phone": "last_two_phone_digits" +} +``` +**App output:** +``` +Setting profile: profile1 + Loading url: https://device.sso.eu-west-1.amazonaws.com/?user_code=XXXX-XXX + Approving code... + Logging user... + Loading app code... + Awaiting approval of code: 59 + Approving access... + Awaiting graceful time... + Executing YAWSSO... +------------------------------------------ + SSO profile 'profile1' token renewed + IAM profile 'profile1-iam' configured +------------------------------------------ +``` +**Call output:** +``` +Setting profile: profile1 + Loading url: https://device.sso.eu-west-1.amazonaws.com/?user_code=XXXX-XXX + Approving code... + Logging user... + Logging with phone call... + Awaiting approval call... + Approving access... + Awaiting graceful time... + Executing YAWSSO... +----------------------------------------- + SSO profile 'profile1' token renewed + IAM profile 'profile-iam' configured +----------------------------------------- +``` ## # License