Skip to content

Commit 3deaf83

Browse files
committed
docs: readme
1 parent d470869 commit 3deaf83

6 files changed

Lines changed: 26 additions & 32 deletions

File tree

README.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,21 @@
22

33
A modern AWS SSO session manager with an interactive TUI, powerful CLI, and a reusable SDK.
44

5-
![awsesh hero](assets/hero.png)
6-
<!-- PLACEHOLDER: A wide banner image showing the awsesh TUI in a terminal. Show the main account selection screen with a few accounts listed, fuzzy search active, and the bottom action bar visible. Dark terminal theme preferred. Dimensions: ~1200x600px -->
5+
<video autoplay loop muted playsinline width="100%">
6+
<source src="assets/hero.mp4" type="video/mp4">
7+
</video>
8+
9+
![awsesh hero](assets/hero.mp4)
710

811
## Features
912

1013
- Interactive terminal UI for managing AWS SSO sessions
14+
- Interactive CLI if that's more your jam
1115
- Fast fuzzy search across accounts and roles
1216
- Multiple SSO profile support
1317
- Automatic credential management
14-
- Browser integration for AWS Console access
18+
- Remappable keybindings
19+
- Browser integration for quick AWS Console access
1520
- Shell integration with environment variable exports
1621
- Reusable SDK for building your own tools
1722
- XDG Base Directory compliant
@@ -25,13 +30,6 @@ brew tap elva-labs/elva
2530
brew install awsesh
2631
```
2732

28-
**Beta version:**
29-
30-
```sh
31-
brew tap elva-labs/elva
32-
brew install awsesh-beta
33-
```
34-
3533
### Pre-built Binaries
3634

3735
Download the latest release from the [Releases page](https://github.com/elva-labs/awsesh/releases/latest).
@@ -69,8 +67,7 @@ Launch the interactive terminal interface:
6967
awsesh
7068
```
7169

72-
![awsesh tui overview](assets/tui-overview.gif)
73-
<!-- PLACEHOLDER: A GIF recording showing the full TUI flow: launching awsesh, selecting an SSO profile, searching for an account with fuzzy search, selecting a role, and seeing the "credentials set" confirmation. ~15-20 seconds. -->
70+
![awsesh tui overview](assets/tui-overview.mp4)
7471

7572
### Navigation
7673

@@ -86,7 +83,6 @@ awsesh
8683
### Managing SSO Profiles
8784

8885
![awsesh profile management](assets/profile-management.png)
89-
<!-- PLACEHOLDER: Screenshot showing the SSO profile list with the action bar at the bottom showing available actions (n=new, e=edit, d=delete, o=open in browser). Show 2-3 example profiles. -->
9086

9187
| Key | Action |
9288
|-----|--------|
@@ -98,7 +94,6 @@ awsesh
9894
### Account & Role Selection
9995

10096
![awsesh account selection](assets/account-selection.png)
101-
<!-- PLACEHOLDER: Screenshot of the account list with fuzzy search active. Show the search input at top with a partial search term, filtered results below, and the match highlighting. Include the role count badge next to account names. -->
10297

10398
| Key | Action |
10499
|-----|--------|
@@ -112,7 +107,6 @@ awsesh
112107
View and manage your active credential sessions:
113108

114109
![awsesh sessions](assets/sessions.png)
115-
<!-- PLACEHOLDER: Screenshot of the active sessions page showing 2-3 active credentials with their profile names, account names, roles, and expiration times. Include the default session indicator. -->
116110

117111
---
118112

@@ -123,11 +117,11 @@ Use awsesh directly from the command line for scripting and automation.
123117
### Quick Usage
124118

125119
```sh
126-
# Set credentials for a specific role
127-
awsesh <sso-profile> <account-name> <role-name>
120+
# Set credentials
121+
awsesh set
128122

129-
# Use last selected role for an account
130-
awsesh <sso-profile> <account-name>
123+
# Set credentials for a specific role
124+
awsesh set <sso-profile> <account-name> <role-name>
131125

132126
# Check current identity
133127
awsesh whoami
@@ -144,7 +138,7 @@ awsesh accounts
144138
| Command | Description |
145139
|---------|-------------|
146140
| `awsesh` | Launch interactive TUI |
147-
| `awsesh <sso> <account> [role]` | Set credentials directly |
141+
| `awsesh set <sso> <account> [role]` | Set credentials directly |
148142
| `awsesh whoami` | Show current AWS identity |
149143
| `awsesh sessions` | List active credential sessions |
150144
| `awsesh accounts` | List cached AWS accounts |
@@ -175,7 +169,7 @@ Add this to your shell config for seamless environment variable integration:
175169

176170
**Bash/Zsh:**
177171
```bash
178-
sesh() {
172+
sesh() { # i personally prefer "sesh" over "awsesh"
179173
eval "$(command awsesh --eval "$@")"
180174
}
181175
```
@@ -187,16 +181,6 @@ function sesh
187181
end
188182
```
189183

190-
This exports AWS environment variables directly to your shell:
191-
192-
```sh
193-
sesh MyOrg MyAccount AdminRole
194-
# Sets: AWS_PROFILE, AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY,
195-
# AWS_SESSION_TOKEN, AWS_SESSION_EXPIRATION
196-
```
197-
198-
---
199-
200184
## SDK
201185

202186
The core functionality is available as a standalone SDK for building your own AWS SSO tools.
@@ -246,7 +230,8 @@ For a complete working example, see the [awsesh-sdk-example](https://github.com/
246230

247231
## Migrating from Go Version
248232

249-
If upgrading from the original Go version of awsesh, run the migration command:
233+
If upgrading from the original Go version of awsesh the mgiration should run automatically.
234+
Otherwise you can run the migration command manually:
250235

251236
```sh
252237
awsesh migrate
@@ -259,6 +244,8 @@ Options:
259244

260245
The migration converts your existing profiles, tokens, and preferences to the new JSON format.
261246

247+
Should the migration fail I suggest you to clean up your `~/.aws` folder and remove most any awsesh files and the aws files `.config` and `.credentials` since they can interfere as well.
248+
262249
---
263250

264251
## Configuration
@@ -284,6 +271,13 @@ Access settings via `Ctrl+P` > Settings in the TUI, or edit `~/.config/awsesh/co
284271

285272
---
286273

274+
## Acknowledgments
275+
276+
Huge thanks to the great team over at [Anomalyco](hhttps://github.com/anomalyco) both for OpenTui and the structure of OpenCode from a few months ago.
277+
I shamelessly based the refactor on the structure of OpenCode at the time and it's been great for me.
278+
279+
---
280+
287281
## License
288282

289283
MIT - see [LICENSE](LICENSE) for details.

assets/account-selection.png

998 KB
Loading

assets/hero.mp4

195 KB
Binary file not shown.

assets/profile-management.png

938 KB
Loading

assets/sessions.png

983 KB
Loading

assets/tui-overview.mp4

626 KB
Binary file not shown.

0 commit comments

Comments
 (0)