Skip to content

Commit 22471ba

Browse files
committed
docs: update readme
1 parent 9a5c31e commit 22471ba

1 file changed

Lines changed: 57 additions & 6 deletions

File tree

README.md

Lines changed: 57 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,37 @@ These settings are optional unless marked otherwise:
578578
| Authorization Server ID | The ID of the Okta authorization server, set ID for a custom authorization server, will use default otherwise. Default `default` | `--authz-id [value]` | `OKTA_AWSCLI_AUTHZ_ID` |
579579
| Custom STS Role Session Name | Customize STS Role Session Name. Default `okta-aws-cli` | `--aws-sts-role-session-name [value]` | `OKTA_AWSCLI_STS_ROLE_SESSION_NAME` |
580580

581+
### Interactive Selection with Fuzzy Search
582+
583+
When multiple IdPs or Roles are available, `okta-aws-cli` presents an interactive
584+
picker with fuzzy search capabilities. This makes it easy to find the right
585+
option even when you have many roles configured.
586+
587+
**Features:**
588+
- **Fuzzy search**: Type to filter options - matches are highlighted
589+
- **Smart filtering**: Search is performed on the role/IdP name only (the part after the last `/`), not the full ARN
590+
- **Keyboard navigation**: Use ``/`` arrows to navigate, `Enter` to select, `Esc` to cancel
591+
- **Scroll indicators**: Shows count of items above/below when list is long
592+
593+
**Example:**
594+
595+
```
596+
? Choose a Role:
597+
598+
> Type to filter...
599+
600+
↑ 5 more above
601+
> arn:aws:iam::123456789012:role/admin <- selected, highlighted
602+
arn:aws:iam::123456789012:role/developer
603+
arn:aws:iam::123456789012:role/readonly
604+
↓ 10 more below
605+
606+
(esc to cancel)
607+
```
608+
609+
When typing `dev`, only roles containing "dev" in the role name will be shown,
610+
with the matching characters highlighted.
611+
581612
### Friendly IdP and Role menu labels
582613

583614
When the operator has many AWS Federation apps listing the AWS IAM IdP ARNs can
@@ -591,18 +622,28 @@ and Roles can also be evaluated are regular expressions (see example below).
591622
`$HOME/.okta/okta.yaml` as a configuration file and location. We will continue
592623
that practice with read-only friendly okta-aws-cli application values.
593624

594-
#### Before
625+
#### Before (without friendly labels)
595626

596627
```
597-
? Choose an IdP: [Use arrows to move, type to filter]
628+
? Choose an IdP:
629+
630+
> Type to filter...
631+
598632
> Fed App 1 Label
599633
Fed App 2 Label
600634
Fed App 3 Label
601635
Fed App 4 Label
602636
603-
? Choose a Role: [Use arrows to move, type to filter]
637+
(esc to cancel)
638+
639+
? Choose a Role:
640+
641+
> Type to filter...
642+
604643
> arn:aws:iam::123456789012:role/admin
605644
arn:aws:iam::123456789012:role/ops
645+
646+
(esc to cancel)
606647
```
607648

608649
#### Example `$HOME/.okta/okta.yaml`
@@ -620,18 +661,28 @@ awscli:
620661
"arn:aws:iam::.*:role/operator": "Ops"
621662
```
622663
623-
#### After
664+
#### After (with friendly labels from okta.yaml)
624665
625666
```
626-
? Choose an IdP: [Use arrows to move, type to filter]
667+
? Choose an IdP:
668+
669+
> Type to filter...
670+
627671
> Data Production
628672
Data Development
629673
Marketing Production
630674
Marketing Development
631675

632-
? Choose a Role: [Use arrows to move, type to filter]
676+
(esc to cancel)
677+
678+
? Choose a Role:
679+
680+
> Type to filter...
681+
633682
> Admin
634683
Ops
684+
685+
(esc to cancel)
635686
```
636687

637688
### Configuration by profile name

0 commit comments

Comments
 (0)